Skip to content

Me API

The Me API exposes information about the currently authenticated user — things the bearer of the access token can read about themselves. It's the easiest entry point for any integration: hit /v1/me and check that the token works.

Endpoints at a glance

Endpoint What it returns
GET /v1/me The user's own record
GET /v1/me/observation-memberships Observations the user is associated with
GET /v1/me/organization-memberships Organizations the user belongs to
GET /v1/me/group-memberships Groups the user belongs to
GET /v1/me/observing-accounts Observing accounts the user can submit through
GET /v1/me/observing-grants Observing grants held directly by the user
GET /v1/me/telescope-access-grants Telescope access grants held directly by the user
GET /v1/me/api-tokens OAuth tokens issued to the user (for personal-access-token management)

The /me route differs from /users/{id} in that it requires no authorization beyond "you can read your own record" — handy for auth bootstrapping.

Common task recipes

  • Token sanity check. GET /v1/me. If it succeeds, the token is valid and you know the user identity.
  • Discover what you can submit to. GET /v1/me/observing-accounts returns the accounts the user can submit observations through — this is what the observation editor's accounts step queries.
  • List your scheduled telescope time. Combine /me/observing-grants with the observation API — observation queries filtered by grant return the observations consuming credit against that grant.

Reference

Me API 2.0.0

Endpoints for the currently authenticated user.

Me

GET /me

Get Current User

Description

Get the current user

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

{
    "affiliation": null,
    "age": null,
    "birthdate": null,
    "country": null,
    "createdOn": null,
    "description": null,
    "email": "string",
    "entityType": "string",
    "facebookId": null,
    "firstName": null,
    "githubId": null,
    "id": 0,
    "language": null,
    "lastName": null,
    "linkedinId": null,
    "location": null,
    "name": "string",
    "orcidId": null,
    "orcidVerifiedAt": null,
    "profileImageId": null,
    "slug": "string",
    "title": null,
    "twitterId": null,
    "username": "string",
    "websiteUrl": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "affiliation": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Affiliation provided by the user in their public profile"
        },
        "age": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Age of the user"
        },
        "birthdate": {
            "anyOf": [
                {
                    "format": "date-time",
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Birthdate provided by the user in their public profile"
        },
        "country": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Country provided by the user or organization in their public profile"
        },
        "createdOn": {
            "anyOf": [
                {
                    "format": "date-time",
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Creation time of this account"
        },
        "description": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Description/Bio provided by the user or organization in their public profile"
        },
        "email": {
            "description": "Email address of the user",
            "type": "string"
        },
        "entityType": {
            "const": "user",
            "description": "Type of entity (user/organization)",
            "type": "string"
        },
        "facebookId": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Facebook ID provided by the user in their public profile"
        },
        "firstName": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "First name of the user"
        },
        "githubId": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "GitHub ID provided by the user in their public profile"
        },
        "id": {
            "description": "Unique identifier of the user/organization.",
            "type": "integer"
        },
        "language": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Language provided by the user or organization in their public profile"
        },
        "lastName": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Last name of the user"
        },
        "linkedinId": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "LinkedIn ID provided by the user in their public profile"
        },
        "location": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Location provided by the user or organization in their public profile"
        },
        "name": {
            "description": "Name of the user/organization.",
            "type": "string"
        },
        "orcidId": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "OAuth-verified ORCID iD shown on the public profile"
        },
        "orcidVerifiedAt": {
            "anyOf": [
                {
                    "format": "date-time",
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "When the ORCID iD was verified via OAuth (null = no verified iD)"
        },
        "profileImageId": {
            "anyOf": [
                {
                    "format": "uuid",
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Profile image of the user/organization."
        },
        "slug": {
            "description": "Unique identifier used in URLs referencing the user/organization.",
            "type": "string"
        },
        "title": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Title provided by the user in their public profile"
        },
        "twitterId": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Twitter ID provided by the user in their public profile"
        },
        "username": {
            "description": "Username of the user",
            "type": "string"
        },
        "websiteUrl": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "description": "Website URL provided by the user or organization in their public profile"
        }
    },
    "required": [
        "id",
        "name",
        "slug",
        "entityType",
        "username",
        "email"
    ],
    "title": "UserWithEmail",
    "type": "object"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/connected-apps

Get Connected Apps

Description

OAuth clients the current user has granted access to.

A client appears if the user holds at least one active (unexpired) token for it. Drives the "connected apps / revoke" settings surface — e.g. "Afterglow has read access to your observations". First-party clients (the website itself) are included with isFirstParty=true so the UI can present or hide them as it sees fit.

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    {
        "clientId": "string",
        "description": null,
        "grantedAt": null,
        "isFirstParty": true,
        "lastActiveAt": null,
        "logoUrl": null,
        "name": "string",
        "scopes": [
            "string"
        ]
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/ConnectedApp"
    },
    "title": "Response Get Connected Apps Me Connected Apps Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

DELETE /me/connected-apps/{client_id}

Revoke Connected App

Description

Revoke an OAuth client's access for the current user.

Deletes every token the user holds for the client (purging the auth cache) and drops the consent row, so the client can no longer act for the user. Idempotent.

Input parameters

Parameter In Type Default Nullable Description
client_id path string No
token query No

Responses

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/group-roles

Get Current User Group Roles

Description

Group role-grants held by the current user.

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    {
        "grantedOn": "2022-04-13T15:42:05.901Z",
        "grantorId": null,
        "groupId": 0,
        "id": 0,
        "roleName": "maintainer",
        "userId": 0
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/GroupRoleGrant"
    },
    "title": "Response Get Current User Group Roles Me Group Roles Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/invitations

Get Current User Pending Invitations

Description

Pending invitations addressed to the current user's email.

Lets the post-registration / dashboard UI surface invitations a user was sent before they had an account (the email match in the accept flow only works once the account exists). Registration invitations are excluded — they're consumed by the registration flow itself. (C10)

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    null
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "discriminator": {
            "mapping": {
                "externally_managed_observing_grant_invitation": "#/components/schemas/ExternallyManagedObservingGrantInvitation",
                "group_invitation": "#/components/schemas/GroupInvitation",
                "organization_invitation": "#/components/schemas/OrganizationInvitation",
                "registration_invitation": "#/components/schemas/RegistrationInvitation",
                "telescope_access_grant_invitation": "#/components/schemas/TelescopeAccessGrantInvitation"
            },
            "propertyName": "invitationType"
        },
        "oneOf": [
            {
                "$ref": "#/components/schemas/OrganizationInvitation"
            },
            {
                "$ref": "#/components/schemas/RegistrationInvitation"
            },
            {
                "$ref": "#/components/schemas/GroupInvitation"
            },
            {
                "$ref": "#/components/schemas/ExternallyManagedObservingGrantInvitation"
            },
            {
                "$ref": "#/components/schemas/TelescopeAccessGrantInvitation"
            }
        ]
    },
    "title": "Response Get Current User Pending Invitations Me Invitations Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/observing-access/observation-types

Read Observing Access Observation Types

Input parameters

Parameter In Type Default Nullable Description
account_id query No
account_is_deleted query No
account_owner_id query No
accountId query No
accountIsDeleted query No
accountOwnerId query No
assignee query all No
grant_type query No
grantType query No
group_id query No
groupId query No
id query No
instrument_type query No
instrumentType query No
managing_entity_id query No
managing_group_id query No
managingEntityId query No
managingGroupId query No
observation_type query No
observationType query No
revoked query No
token query No

Responses

[
    "optical_imaging"
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/ObservationType"
    },
    "title": "Response Read Observing Access Observation Types Me Observing Access Observation Types Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/observing-access/observing-grants

Read Observing Access Observing Grants

Input parameters

Parameter In Type Default Nullable Description
account_id query No
account_is_deleted query No
account_owner_id query No
accountId query No
accountIsDeleted query No
accountOwnerId query No
assignee query all No
grant_type query No
grantType query No
group_id query No
groupId query No
id query No
instrument_type query No
instrumentType query No
managing_entity_id query No
managing_group_id query No
managingEntityId query No
managingGroupId query No
observation_type query No
observationType query No
revoked query No
token query No

Responses

[
    null
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "discriminator": {
            "mapping": {
                "externally_managed": "#/components/schemas/ExternallyManagedObservingGrantSummary",
                "group": "#/components/schemas/GroupObservingGrantSummary",
                "group_managed": "#/components/schemas/GroupManagedObservingGrantSummary",
                "member": "#/components/schemas/MemberObservingGrantSummary",
                "owner": "#/components/schemas/OwnerObservingGrantSummary"
            },
            "propertyName": "grantType"
        },
        "oneOf": [
            {
                "$ref": "#/components/schemas/MemberObservingGrantSummary"
            },
            {
                "$ref": "#/components/schemas/GroupObservingGrantSummary"
            },
            {
                "$ref": "#/components/schemas/OwnerObservingGrantSummary"
            },
            {
                "$ref": "#/components/schemas/ExternallyManagedObservingGrantSummary"
            },
            {
                "$ref": "#/components/schemas/GroupManagedObservingGrantSummary"
            }
        ]
    },
    "title": "Response Read Observing Access Observing Grants Me Observing Access Observing Grants Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/observing-access/owners

Read Observing Access Owners

Input parameters

Parameter In Type Default Nullable Description
account_id query No
account_is_deleted query No
account_owner_id query No
accountId query No
accountIsDeleted query No
accountOwnerId query No
assignee query all No
grant_type query No
grantType query No
group_id query No
groupId query No
id query No
instrument_type query No
instrumentType query No
managing_entity_id query No
managing_group_id query No
managingEntityId query No
managingGroupId query No
observation_type query No
observationType query No
revoked query No
token query No

Responses

[
    null
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "discriminator": {
            "mapping": {
                "organization": "#/components/schemas/Organization",
                "user": "#/components/schemas/User"
            },
            "propertyName": "entityType"
        },
        "oneOf": [
            {
                "$ref": "#/components/schemas/User"
            },
            {
                "$ref": "#/components/schemas/Organization"
            }
        ]
    },
    "title": "Response Read Observing Access Owners Me Observing Access Owners Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/observing-access/telescopes

Read Observing Access Telescopes

Input parameters

Parameter In Type Default Nullable Description
account_id query No
account_is_deleted query No
account_owner_id query No
accountId query No
accountIsDeleted query No
accountOwnerId query No
assignee query all No
grant_type query No
grantType query No
group_id query No
groupId query No
id query No
instrument_type query No
instrumentType query No
managing_entity_id query No
managing_group_id query No
managingEntityId query No
managingGroupId query No
observation_type query No
observationType query No
revoked query No
token query No

Responses

[
    {
        "antennaIds": null,
        "antennas": [
            {
                "apertureM": 10.12,
                "deviceType": "string",
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": [
                    {
                        "action": "keep_enclosure_closed",
                        "deviceId": 0,
                        "deviceUid": null,
                        "id": null,
                        "operationalConstraintId": 0,
                        "priority": 0,
                        "triggerOnStabilizing": true,
                        "triggerOnUnknown": true,
                        "triggerOnUnsafe": true,
                        "uid": "7d0cebff-8de3-4a91-a044-d0fa907a31ef"
                    }
                ],
                "operationalConstraintIds": null,
                "ownerId": 0,
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "eeed5689-2bb5-4e2b-a0e9-3e382b6d077d"
            }
        ],
        "calibrationObservingAccountId": null,
        "cameraIds": null,
        "cameras": [
            {
                "arrayHeight": 0,
                "arrayWidth": 0,
                "coolerIdleTimeoutSec": 10.12,
                "coolerPolicy": "always_on",
                "coolerPrestartLeadTimeSec": 10.12,
                "defaultBinning": 0,
                "deviceType": "string",
                "fullWellCapacityElectrons": 10.12,
                "hasElectronicShutter": true,
                "id": null,
                "imageId": null,
                "isColor": true,
                "isGlobalShutter": true,
                "manufacturer": null,
                "model": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "pixelSizeUm": 10.12,
                "readoutModes": null,
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "temperatureSetpointC": null,
                "temperatureSetpointToleranceC": null,
                "uid": "cef7fcca-5aa2-4481-a013-583186b5d18e"
            }
        ],
        "description": null,
        "deviceIds": null,
        "elevationM": 10.12,
        "enclosure": null,
        "enclosureId": null,
        "enclosureUid": null,
        "filterWheelIds": null,
        "filterWheels": [
            {
                "deletedPositions": null,
                "deviceType": "string",
                "filterShape": null,
                "filterSizeMm": null,
                "filterWheelPositionIds": null,
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "model": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "positions": [
                    {
                        "filterIds": [
                            "string"
                        ],
                        "filterWheelId": 0,
                        "filterWheelUid": null,
                        "filters": [
                            {
                                "bandpassNm": null,
                                "centralWavelengthNm": null,
                                "filterSpecifierType": "string",
                                "flatExposureScaler": null,
                                "flatExposureSunElevationCoeffPerDeg": null,
                                "id": "string",
                                "isModifier": null,
                                "throughputFraction": null
                            }
                        ],
                        "flatExposureScaler": null,
                        "focusOffset": null,
                        "id": null,
                        "isActive": true,
                        "isDeleted": true,
                        "label": null,
                        "position": 0,
                        "uid": "b8aacdb5-e9e6-464d-8e2c-ea8ff45f82f0"
                    }
                ],
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "4366ede4-cef0-4138-a987-16b9b952108f"
            }
        ],
        "focuserIds": null,
        "focusers": [
            {
                "deviceType": "string",
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "maxPosition": 0,
                "minPosition": 0,
                "model": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "serialNumber": null,
                "stepSize": 10.12,
                "telescopeId": null,
                "telescopeUid": null,
                "temperatureCompensated": true,
                "uid": "d35bb5ce-19fa-4491-afb7-c6af660f4750"
            }
        ],
        "galleryItemIds": null,
        "galleryItems": null,
        "iauCode": null,
        "id": null,
        "imageId": null,
        "instrumentIds": null,
        "instruments": [
            null
        ],
        "ipCameraIds": null,
        "ipCameras": [
            {
                "id": null,
                "isPrimary": true,
                "lastSeen": null,
                "name": "string",
                "observatoryId": null,
                "onvifHost": null,
                "order": 0,
                "pose": null,
                "ptz": true,
                "role": "pier",
                "streams": [
                    {
                        "active": true,
                        "cameraId": 0,
                        "expiresSec": null,
                        "id": 0,
                        "isPublic": true,
                        "kind": "rtsp",
                        "quality": null
                    }
                ],
                "telescopeId": null,
                "uid": "25bc2503-6834-4211-8b9b-6492a911bb8b",
                "vendor": null
            }
        ],
        "isAvailable": true,
        "isPublic": true,
        "latitudeDeg": 10.12,
        "localHorizon": null,
        "location": "string",
        "longitudeDeg": 10.12,
        "mount": null,
        "mountId": null,
        "mountUid": null,
        "name": "string",
        "observatory": null,
        "observatoryId": 0,
        "observatoryUid": null,
        "otaIds": null,
        "otas": [
            {
                "apertureM": 10.12,
                "deviceType": "string",
                "focalLengthM": 10.12,
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "model": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "offsetScalar": null,
                "offsetXM": null,
                "offsetYM": null,
                "offsetZM": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "opticalDesign": null,
                "ownerId": 0,
                "parentOta": null,
                "parentOtaId": null,
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "01a39029-bf7d-4039-b731-2772d52d9f7f"
            }
        ],
        "owner": null,
        "ownerId": 0,
        "publicLatitudeDeg": null,
        "publicLongitudeDeg": null,
        "radioBackendIds": null,
        "radioBackends": [
            {
                "description": null,
                "deviceType": "string",
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "radioFilters": [
                    {
                        "id": 0,
                        "name": null,
                        "startFrequencyMhz": 10.12,
                        "stopFrequencyMhz": 10.12
                    }
                ],
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "82ada6f3-513c-4750-923b-ee3c95aed248"
            }
        ],
        "receiverIds": null,
        "receivers": [
            {
                "band": null,
                "channels": [
                    {
                        "id": 0,
                        "isActive": true,
                        "offsetXArcsec": 10.12,
                        "offsetYArcsec": 10.12,
                        "polarization": "linear",
                        "receiverId": 0
                    }
                ],
                "deviceType": "string",
                "id": 0,
                "imageId": null,
                "isAvailable": true,
                "manufacturer": null,
                "maxFrequencyMhz": 10.12,
                "minFrequencyMhz": 10.12,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "646e93e9-aa3e-444e-bbe2-3d81f6a4aa53"
            }
        ],
        "rotatorIds": null,
        "rotators": [
            {
                "deviceType": "string",
                "id": null,
                "imageId": null,
                "manufacturer": null,
                "modelId": null,
                "name": null,
                "observatoryId": null,
                "observatoryUid": null,
                "operationalConstraintActions": null,
                "operationalConstraintIds": null,
                "ownerId": 0,
                "serialNumber": null,
                "telescopeId": null,
                "telescopeUid": null,
                "uid": "eab2fc34-3f77-4c99-bda6-33003835836f"
            }
        ],
        "shortName": null,
        "slug": "string",
        "uid": "99e415f4-2f20-4c27-953b-f7d6dd1639b9"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/TelescopeWithCapabilities"
    },
    "title": "Response Read Observing Access Telescopes Me Observing Access Telescopes Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/organization-roles

Get Current User Organization Roles

Description

Organization role-grants held by the current user, directly or via a group.

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    {
        "grantedOn": "2022-04-13T15:42:05.901Z",
        "grantorId": null,
        "groupId": null,
        "id": 0,
        "organizationId": 0,
        "roleName": "owner",
        "userId": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/OrganizationRoleGrant"
    },
    "title": "Response Get Current User Organization Roles Me Organization Roles Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/organizations-with-roles

Get Current User Organizations With Roles

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    {
        "organization": {
            "allowRequestToJoin": true,
            "country": null,
            "createdOn": null,
            "defaultRoleId": null,
            "description": null,
            "entityType": "string",
            "id": 0,
            "isPublic": true,
            "location": null,
            "memberCount": null,
            "membersVisibleToMembers": true,
            "name": "string",
            "observingPolicyIds": null,
            "profileImageId": null,
            "shortName": null,
            "slug": "string",
            "websiteUrl": null
        },
        "roleNames": [
            "owner"
        ]
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/OrganizationWithRoles"
    },
    "title": "Response Get Current User Organizations With Roles Me Organizations With Roles Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

GET /me/skynet-roles

Get Current User Skynet Roles

Description

Skynet-wide role-names held by the current user.

Input parameters

Parameter In Type Default Nullable Description
token query No

Responses

[
    "calibration_scheduler"
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "items": {
        "$ref": "#/components/schemas/SkynetRoleName"
    },
    "title": "Response Get Current User Skynet Roles Me Skynet Roles Get",
    "type": "array"
}


{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "title": "Detail",
            "type": "array"
        }
    },
    "title": "HTTPValidationError",
    "type": "object"
}

Schemas

Antenna

Name Type Description
apertureM number
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

AntennaDetail

Name Type Description
apertureM number
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

AssetCreationMethod

Type: string

CalibrationMasterStrategy

Type: string

Camera

Name Type Description
arrayHeight integer Number of physical pixels along the vertical axis.
arrayWidth integer Number of physical pixels along the horizontal axis.
coolerIdleTimeoutSec number Idle timeout in seconds before turning off the cooler.
coolerPolicy CameraCoolerPolicy Camera cooler policy for automatic temperature control.
coolerPrestartLeadTimeSec number Lead time in seconds to pre-cool before tasks.
defaultBinning integer Default binning factor for the camera.
deviceType string
fullWellCapacityElectrons number Unbinned full well capacity in electrons.
hasElectronicShutter boolean Whether the camera has an electronic shutter.
id The unique identifier for the device.
imageId Image asset ID for the device.
isColor boolean Whether the camera is color or monochrome.
isGlobalShutter boolean Whether the camera is either a CCD or a global shutter CMOS.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
pixelSizeUm number Unbinned pixel size in microns.
readoutModes
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
temperatureSetpointC Target camera temperature setpoint in degrees Celsius.
temperatureSetpointToleranceC Allowed temperature tolerance in degrees Celsius.
uid string(uuid) The unique UID for the device.

CameraCoolerPolicy

Type: string

CameraDetail

Name Type Description
arrayHeight integer Number of physical pixels along the vertical axis.
arrayWidth integer Number of physical pixels along the horizontal axis.
coolerIdleTimeoutSec number Idle timeout in seconds before turning off the cooler.
coolerPolicy CameraCoolerPolicy Camera cooler policy for automatic temperature control.
coolerPrestartLeadTimeSec number Lead time in seconds to pre-cool before tasks.
defaultBinning integer Default binning factor for the camera.
deviceType string
fullWellCapacityElectrons number Unbinned full well capacity in electrons.
hasElectronicShutter boolean Whether the camera has an electronic shutter.
id The unique identifier for the device.
imageId Image asset ID for the device.
isColor boolean Whether the camera is color or monochrome.
isGlobalShutter boolean Whether the camera is either a CCD or a global shutter CMOS.
manufacturer
model
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
pixelSizeUm number Unbinned pixel size in microns.
readoutModes
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
temperatureSetpointC Target camera temperature setpoint in degrees Celsius.
temperatureSetpointToleranceC Allowed temperature tolerance in degrees Celsius.
uid string(uuid) The unique UID for the device.

CameraModel

Name Type Description
arrayHeight integer
arrayWidth integer
deviceType string
fullWellCapacity number
hasElectronicShutter boolean
id
imageId
isColor boolean
isGlobalShutter boolean
manufacturer
modelName string
pixelSize number
readoutModes

CameraReadoutMode

Name Type Description
binning integer Binning factor for the readout mode.
bitDepth integer Bit depth for the readout mode.
blankLevelCounts number Blank level in counts.
cameraId ID of the camera this readout mode belongs to.
cameraModelId ID of the camera model this readout mode belongs to.
darkCurrentElectronsPerSec number Dark current in electrons/second at standard temperature.
description string Description of the readout mode.
gainElectronsPerCount number Inverse gain factor in electrons/count.
hardwareId string ID of the readout mode in the TCS backend.
id integer ID of the readout mode.
isFastReadout boolean Whether the readout mode is fast.
isHdr boolean Whether the readout mode is high dynamic range.
isHighGain boolean Whether the readout mode is high gain.
isLdr boolean Whether the readout mode is low dynamic range.
isLowGain boolean Whether the readout mode is low gain.
isLowNoise boolean Whether the readout mode is low noise.
isNonRbiFlood boolean Whether RBI flooding is disabled for the readout mode.
isRbiFlood boolean Whether RBI flooding is enabled for the readout mode.
readoutNoiseElectrons number Readout noise in electrons.
readoutTimeSec number Full-frame readout time in seconds.

CatalogObjectType

Type: string

ConnectedApp

Name Type Description
clientId string
description
grantedAt
isFirstParty boolean
lastActiveAt
logoUrl
name string
scopes Array<string>

CoordinateType

Type: string

DataPolicy

Type: string

EnclosureDetail

Name Type Description
deviceType string
diameterM Diameter of the enclosure in meters.
enclosurePolicy EnclosurePolicy Enclosure policy for automatic opening/closing behavior.
enclosureType EnclosureType
hasRotation boolean
hasShutter boolean
id The unique identifier for the device.
idleCloseTimeoutSec Idle time in seconds before closing when open-for-tasks-only policy is active.
imageId Image asset ID for the device.
manufacturer
model
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
slitWidthM Width of the dome slit in meters.
sunAltitudeOpenCondition SunAltitudeOpenCondition Condition that determines when to open based on sun altitude.
sunAltitudeThresholdDeg Sun altitude threshold used to determine when to open (degrees).
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.
zenithOverlapAngleDeg Zenith overlap angle in degrees.

EnclosureModel

Name Type Description
deviceType string
diameterM
enclosureType
hasRotation boolean
hasShutter boolean
id
imageId
manufacturer
modelName string
slitWidth
zenithOverlapAngleDeg Zenith overlap angle in degrees.

EnclosurePolicy

Type: string

EnclosureType

Type: string

ExternallyManagedObservingGrantInvitation

Name Type Description
createdById Entity who created the invitation.
createdOn string(date-time)
email
emailSent boolean
entityId
expiresIn integer
id string(uuid)
invitationType string
lastSentOn
status InvitationStatus
used boolean

ExternallyManagedObservingGrantSummary

Name Type Description
account
accountId integer
allowExternalDelegation boolean
createdById
createdOn
creditsUsed
entity
entityId integer
grantType string
id integer
quotas
revoked boolean
revokedById
revokedOn

File

Name Type Description
altTag
bucket
createdBy
createdOn string(date-time)
id string(uuid)
isDataReady boolean
lastAccessedOn
mimeType MimeType
name string
objectKey
remoteUri
renderSettings
secretLinkKey
sizeBytes
storageType
updatedOn string(date-time)
visibility FileVisibility

FileVisibility

Type: string

Filter

Name Type Description
bandpassNm Bandpass of the filter in nanometers
centralWavelengthNm Central wavelength of the filter in nanometers
filterSpecifierType string
flatExposureScaler Scale factor applied to the base twilight flat exposure time for this filter.
flatExposureSunElevationCoeffPerDeg Per-degree coefficient b in the twilight-flat first-guess model exptime ~ exp(b*|sun_elevation_deg|); ~1.2 broadband, ~0.9 narrowband; null defaults to 1.2.
id string Unique identifier of the filter specifier
isModifier True if the filter is a modifier (e.g. polarizer)
throughputFraction Relative broadband throughput (0-1) for plate-solve filter selection; null = unknown

FilterShape

Type: string

FilterWheelDetail

Name Type Description
deletedPositions Deleted filter wheel positions when explicitly requested.
deviceType string
filterShape The shape of the filter slot
filterSizeMm The diameter of the filter slot if round the length of a side if square in millimeters
filterWheelPositionIds List of filter wheel position PKs
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
model
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
positions Array<FilterWheelPositionDetail> List of filter wheel positions.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

FilterWheelModel

Name Type Description
deviceType string
filterShape
filterSize
id
imageId
manufacturer
modelName string

FilterWheelPositionDetail

Name Type Description
filterIds Array<string> Filter specifier IDs for this position.
filters Array<Filter> List of filters in this position
filterWheelId integer The ID of the filter wheel this position belongs to.
filterWheelUid The UID of the filter wheel this position belongs to.
flatExposureScaler Initial twilight flat exposure scale in seconds for this filter wheel position.
focusOffset The focus offset in mm when this filter is in use.
id The unique identifier for the filter wheel position.
isActive boolean Whether this filter wheel position is selectable.
isDeleted boolean Whether this filter wheel position is removed from the current configuration view.
label The label of the filter wheel position.
position integer The zero-based slot index of the filter wheel position.
uid string(uuid) The unique UID for the filter wheel position.

FlatFieldSource

Type: string

Focuser

Name Type Description
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
maxPosition integer Maximum focuser position.
minPosition integer Minimum focuser position.
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
stepSize number Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others).
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
temperatureCompensated boolean Whether temperature compensation is supported.
uid string(uuid) The unique UID for the device.

FocuserDetail

Name Type Description
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
maxPosition integer Maximum focuser position.
minPosition integer Minimum focuser position.
model
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
stepSize number Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others).
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
temperatureCompensated boolean Whether temperature compensation is supported.
uid string(uuid) The unique UID for the device.

FocuserModel

Name Type Description
deviceType string
id
imageId
manufacturer
maxPosition integer
minPosition integer
modelName string
stepSize number
temperatureCompensated boolean

FocusTemperatureSource

Type: string

GroupInvitation

Name Type Description
createdById Entity who created the invitation.
createdOn string(date-time)
email
emailSent boolean
entityId
expiresIn integer
groupId integer
id string(uuid)
invitationType string
lastSentOn
roleNames Array<GroupRoleName>
status InvitationStatus
used boolean

GroupManagedObservingGrantSummary

Name Type Description
account
accountId integer
createdById
createdOn
creditsUsed
grantType string
group GroupSummary
groupId integer
id integer
quotas
revoked boolean
revokedById
revokedOn

GroupObservingGrantSummary

Name Type Description
account
accountId integer
createdById
createdOn
creditsUsed
grantType string
group GroupSummary
groupId integer
id integer
quotas
revoked boolean
revokedById
revokedOn

GroupRoleGrant

Name Type Description
grantedOn string(date-time)
grantorId
groupId integer
id integer
roleName GroupRoleName
userId integer

GroupRoleName

Type: string

GroupSummary

Name Type Description
allowDataPolicyOverride boolean Whether overriding the data policy is allowed
allowInvitations boolean Whether invitations are allowed
dataPolicy Data policy.
defaultRoleId Default role for users in this group.
description string Description of the group
id integer Unique identifier of the group.
memberCount Number of members in the group
name string Name of the group
organizationId Unique identifier of the organization to which the group belongs
slug string Unique identifier used in URLs referencing the group.

HTTPValidationError

Name Type Description
detail Array<ValidationError>

InstrumentRotator

Name Type Description
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

InstrumentRotatorDetail

Name Type Description
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

InstrumentType

Type: string

InvitationStatus

Type: string

IPCamera

Name Type Description
id
isPrimary boolean
lastSeen
name string
observatoryId
onvifHost
order integer
pose
ptz boolean
role IPCameraRole
streams Array<IPCameraStream>
telescopeId
uid string(uuid)
vendor

IPCameraRole

Type: string

IPCameraStream

Name Type Description
active boolean
cameraId integer
expiresSec
id integer
isPublic boolean
kind StreamKind
quality

MemberObservingGrantSummary

Name Type Description
account
accountId integer
createdById
createdOn
creditsUsed
grantType string
id integer
quotas
revoked boolean
revokedById
revokedOn
user UserWithEmail
userId integer

MimeType

Type: string

MountDetail

Name Type Description
defaultPierSide PierSide
deviceType string
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
maxSlewAccelerationAxis1DegPerSec2
maxSlewAccelerationAxis2DegPerSec2
maxSlewRateAxis1DegPerSec number
maxSlewRateAxis2DegPerSec number
maxSlewRateDegPerSec number
maxTrackingDurationSec number
meridianAvoidanceDeg number
meridianTrackingLimitDeg number
minAltitudeDeg number
model
modelId
mountType MountType
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
pivotXM number X coordinate of the mount pivot in meters.
pivotYM number Y coordinate of the mount pivot in meters.
pivotZM number Z coordinate of the mount pivot in meters.
serialNumber Serial number for the device.
settleTimeSec number Seconds the mount must hold within the on-target tolerance before it reports on-target.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.
zenithAvoidanceDeg number

MountModel

Name Type Description
defaultPierSide PierSide
deviceType string
id
imageId
manufacturer
maxSlewAccelerationAxis1DegPerSec2
maxSlewAccelerationAxis2DegPerSec2
maxSlewRateAxis1DegPerSec number
maxSlewRateAxis2DegPerSec number
meridianTrackingLimitDeg number
modelName string
mountType MountType

MountType

Type: string

ObservationType

Type: string

ObservatoryGalleryItem

Name Type Description
file
fileId string(uuid)
id integer
observatoryId integer
order
visibility boolean

ObservatorySummary

Name Type Description
countryCode string
description
elevationM number
galleryItemIds
iauCode
id
imageId
ipCameraIds
isAvailable boolean
isPublic boolean
latitudeDeg number
location string
longitudeDeg number
name string
owner
ownerId integer
publicLatitudeDeg
publicLongitudeDeg
shortName
site
siteId
siteUid
slug string
telescopeIds
uid string(uuid)
weatherSensorIds

ObservatoryWithoutTelescopes

Name Type Description
countryCode string
description
elevationM number
galleryItemIds
galleryItems Array<ObservatoryGalleryItem>
iauCode
id
imageId
ipCameraIds
ipCameras Array<IPCamera>
isAvailable boolean
isPublic boolean
latitudeDeg number
location string
longitudeDeg number
name string
owner
ownerId integer
publicLatitudeDeg
publicLongitudeDeg
shortName
site
siteId
siteUid
slug string
telescopeIds
telescopes Array<TelescopeSummary>
uid string(uuid)
weatherSensorIds
weatherSensors Array<WeatherSensor>

ObservingAccountQuota

Name Type Description
accountId integer
anchorAt
createdOn string(date-time)
creditsRemainingInWindow number
creditsUsedInWindow number
currentWindowEnd
currentWindowStart
enabled boolean
id integer
maxCredits number
periodType ObservingQuotaPeriodType
startsAtLocalTime
timezone string
updatedOn string(date-time)

ObservingAccountSummary

Name Type Description
creditsUsed
effectiveQueueAccessGrants
id integer
isDeleted boolean
lastActivityOn
managingGroup
managingGroupId
name
observingPolicy
observingPolicyId
order integer
owner
ownerId integer
path
queueAccessGrantIds
quotas
slug
sourceAccountGrantId
sourceAccountId
sponsor

ObservingDataPolicy

Type: string

ObservingGrantQuota

Name Type Description
anchorAt
createdOn string(date-time)
creditsRemainingInWindow number
creditsUsedInWindow number
currentWindowEnd
currentWindowStart
enabled boolean
grantId integer
id integer
maxCredits number
periodType ObservingQuotaPeriodType
startsAtLocalTime
timezone string
updatedOn string(date-time)

ObservingGrantType

Type: string

ObservingPolicySummary

Name Type Description
allowedCatalogObjectTypes
allowedCoordinateTypes
allowedDataPolicies Array<ObservingDataPolicy>
allowedRequestTypes Array<ObservationType>
allowedTargetPositionTypes
allowHiddenObservation boolean
allowHiddenTelemetry boolean
dataPublicAfter
description
id integer
name string
organizationId integer

ObservingQueueAccessGrantSummary

Name Type Description
effectiveOrder integer
id integer
observingPolicyId
order integer
queue
queueId integer
revoked boolean
telescopeAccessGrant
telescopeAccessGrantId integer
timeContested number
timeUsed number
timeWaiting number

ObservingQueueAccessPrioritization

Type: string

ObservingQueueSummary

Name Type Description
accessPrioritization ObservingQueueAccessPrioritization
canInterrupt boolean
description string
enabled boolean
id integer
name string
order integer
slug string
telescope
telescopeId integer

ObservingQuotaPeriodType

Type: string

OperationalConstraintAction

Name Type Description
action OperationalConstraintActionType
deviceId integer
deviceUid
id
operationalConstraintId integer
priority integer
triggerOnStabilizing boolean
triggerOnUnknown boolean
triggerOnUnsafe boolean
uid string(uuid)

OperationalConstraintActionType

Type: string

OpticalImagerCalibrationConfiguration

Name Type Description
biasMaxSunElevationDeg number Maximum allowed Sun elevation for bias calibrations (degrees)
biasMinSunElevationDeg number Minimum allowed Sun elevation for bias calibrations (degrees)
calibrationIntervalHours number Interval between bias/dark calibration samples (hours)
calibrationObservationMaxAgeHours number Roll the calibration observation over once it is older than this (hours)
calibrationObservationMaxTasks integer Roll the calibration observation over once it has this many tasks
darkExposureTimes Array<number> Dark exposure times to collect, in seconds.
darkMaxSunElevationDeg number Maximum allowed Sun elevation for dark calibrations (degrees)
darkMinSunElevationDeg number Minimum allowed Sun elevation for dark calibrations (degrees)
flatFieldSource FlatFieldSource Flat field illumination source
flatToleranceFraction number Fractional tolerance for flat-field average counts
imagerId integer Optical imager ID
maxExposureTimeSec number Maximum acceptable exposure time for flats (seconds)
minExposureTimeSec number Minimum acceptable exposure time for flats (seconds)
numBiases integer Number of bias frames
numDarks integer Number of dark frames
numFlats integer Number of flat frames
screenFlatEnclosureAzimuthDeg Enclosure azimuth for enclosure-screen flats (degrees)
screenFlatMaxSunElevationDeg number Maximum allowed Sun elevation for enclosure-screen flat calibrations (degrees)
screenFlatMinSunElevationDeg number Minimum allowed Sun elevation for enclosure-screen flat calibrations (degrees)
screenFlatMountAltitudeDeg Mount altitude for enclosure-screen flats (degrees)
screenFlatMountAzimuthDeg Mount azimuth for enclosure-screen flats (degrees)
targetFullWellFraction number Target fraction of full well depth for flats
twilightFlatIntervalHours number Interval between samples of each twilight-flat filter (hours)
twilightFlatMaxSunElevationDeg number Maximum allowed Sun elevation for twilight flat calibrations (degrees)
twilightFlatMinSunElevationDeg number Minimum allowed Sun elevation for twilight flat calibrations (degrees)

OpticalImagerDetail

Name Type Description
calibrationConfiguration Calibration configuration
calibrationMasterStrategy CalibrationMasterStrategy How calibration masters are produced
camera Camera details
cameraId integer Camera PK
cameraUid Camera UID
configurationUpdatedOn string(date-time) Timestamp of last scheduling-relevant configuration update
configurationVersion integer Monotonic scheduling configuration version
filterCombinations Allowed filter combos
filterWheelIds Array<integer> Filter Wheel PKs
filterWheels Array<FilterWheelDetail>
filterWheelUids Filter Wheel UIDs
focuser Focuser details
focuserId Focuser PK
focuserUid Focuser UID
focusReferenceTemperatureC Reference temperature for focus calibration
focusTemperatureCompensationEnabled boolean Whether focus temperature compensation is enabled
focusTemperatureSlope Focus slope (position units per degree)
focusTemperatureSource Temperature source for focus compensation
focusZeroPoint Focuser position at reference temperature
fov FOV (width, height) in degrees
id Instrument PK
instrumentRotator Instrument rotator details
instrumentRotatorId Instrument rotator PK
instrumentRotatorUid Instrument rotator UID
instrumentType string Optical imager
isActive boolean Is active?
name string Instrument name
ota OTA details
otaId integer OTA PK
otaUid OTA UID
pixelScale Pixel scale (arcsec/pixel)
pointingRefinementEnabled boolean Whether pre-flight pointing refinement runs for this imager
seeingArcsec number Seeing (arcsec)
skyParams Sky parameters
solveBlindFallbackEnabled boolean On an adequate-source miss, fall back to a blind triangle solve to recover the reference PA + parity
solveExposureSec number Base solve test-exposure time, scaled by filter throughput
solveFilterPolicy SolveFilterPolicy Solve-filter selection policy
solveLastMeasuredAt When the server pipeline last confirmed/corrected PA/parity
solveMinFilterThroughputFraction number Min filter throughput (0-1) usable for a solve exposure
solveMinSources integer Extracted-source floor splitting the miss remedy: at/above = blind-eligible, below = repoint-eligible
solveParity Net image handedness as the WCS-determinant sign (+1 normal, -1 flipped)
solvePointingRadiusArcmin number Pointing-uncertainty search radius for the constrained solve
solveReferencePositionAngleDeg On-sky PA when the rotator reads 0 (solver adds the live rotator angle)
solveRepointAttempts integer Max repoint-and-retry fields tried on star-poor misses (only used when solve_repoint_enabled)
solveRepointDistanceArcmin number Distance to slew for each repoint attempt (cycling N/E/S/W)
solveRepointEnabled boolean On a star-poor miss, slew to a nearby field, solve there, and apply the correction back to the target
solveRotationToleranceDeg number Max rotation deviation from the prior for the constrained solve
solveScaleToleranceFraction number Max scale deviation from the prior (0-1) for the constrained solve
telescope Telescope
telescopeId integer Owning telescope PK
telescopeUid Owning telescope UID
uid string(uuid) Instrument UID
weatherSensorId Weather sensor PK for ambient focus compensation
weatherSensorUid Weather sensor UID for ambient focus compensation

Organization

Name Type Description
allowRequestToJoin boolean Whether request-to-join is allowed
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
defaultRoleId Default role for users in this organization.
description Description/Bio provided by the user or organization in their public profile
entityType string
id integer Unique identifier of the user/organization.
isPublic boolean Whether the organization is listed in the public directory and exposes a public profile.
location Location provided by the user or organization in their public profile
memberCount Number of members in the organization
membersVisibleToMembers boolean Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).
name string Name of the user/organization.
observingPolicyIds Observing policy PKs configured for the organization.
profileImageId Profile image of the user/organization.
shortName Short name of the organization
slug string Unique identifier used in URLs referencing the user/organization.
websiteUrl Website URL provided by the user or organization in their public profile

OrganizationInvitation

Name Type Description
createdById Entity who created the invitation.
createdOn string(date-time)
email
emailSent boolean
entityId
expiresIn integer
groupAssignments
id string(uuid)
invitationType string
lastSentOn
organizationId integer
roleNames Array<OrganizationRoleName>
status InvitationStatus
used boolean

OrganizationInvitationGroupAssignment

Name Type Description
groupId integer
id integer
roleNames Array<GroupRoleName>

OrganizationPublic

Name Type Description
allowRequestToJoin boolean Whether request-to-join is allowed
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
defaultRoleId Default role for users in this organization.
description Description/Bio provided by the user or organization in their public profile
entityType string
id integer Unique identifier of the user/organization.
isPublic boolean Whether the organization is listed in the public directory and exposes a public profile.
location Location provided by the user or organization in their public profile
memberCount Number of members in the organization
membersVisibleToMembers boolean Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).
name string Name of the user/organization.
observingPolicyIds Observing policy PKs configured for the organization.
profileImageId Profile image of the user/organization.
shortName Short name of the organization
slug string Unique identifier used in URLs referencing the user/organization.
websiteUrl Website URL provided by the user or organization in their public profile

OrganizationRoleGrant

Name Type Description
grantedOn string(date-time)
grantorId
groupId
id integer
organizationId integer
roleName OrganizationRoleName
userId

OrganizationRoleName

Type: string

OrganizationSummary

Name Type Description
allowRequestToJoin boolean Whether request-to-join is allowed
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
defaultRoleId Default role for users in this organization.
description Description/Bio provided by the user or organization in their public profile
entityType string
id integer Unique identifier of the user/organization.
isPublic boolean Whether the organization is listed in the public directory and exposes a public profile.
location Location provided by the user or organization in their public profile
memberCount Number of members in the organization
membersVisibleToMembers boolean Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).
name string Name of the user/organization.
observingPolicyIds Observing policy PKs configured for the organization.
profileImageId Profile image of the user/organization.
shortName Short name of the organization
slug string Unique identifier used in URLs referencing the user/organization.
websiteUrl Website URL provided by the user or organization in their public profile

OrganizationWithRoles

Name Type Description
organization Organization
roleNames Array<OrganizationRoleName>

Ota

Name Type Description
apertureM number Unobstructed aperture of the OTA in meters.
deviceType string
focalLengthM number Focal length of the OTA in meters.
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
offsetScalar Distance from mount pivot to OTA axis in meters along mount reference axis.
offsetXM X offset from parent OTA axis in meters.
offsetYM Y offset from parent OTA axis in meters.
offsetZM Z offset from parent OTA axis in meters.
operationalConstraintIds Operational constraint PKs
opticalDesign
ownerId integer The organization or user which owns the device.
parentOta
parentOtaId ID of the parent OTA if piggybacked.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

OtaDetail

Name Type Description
apertureM number Unobstructed aperture of the OTA in meters.
deviceType string
focalLengthM number Focal length of the OTA in meters.
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
model
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
offsetScalar Distance from mount pivot to OTA axis in meters along mount reference axis.
offsetXM X offset from parent OTA axis in meters.
offsetYM Y offset from parent OTA axis in meters.
offsetZM Z offset from parent OTA axis in meters.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
opticalDesign
ownerId integer The organization or user which owns the device.
parentOta
parentOtaId ID of the parent OTA if piggybacked.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

OtaModel

Name Type Description
apertureM number
deviceType string
focalLength number
id
imageId
manufacturer
modelName string
opticalDesign

OwnerObservingGrantSummary

Name Type Description
account
accountId integer
createdById
createdOn
creditsUsed
grantType string
id integer
quotas
revoked boolean
revokedById
revokedOn

PierSide

Type: string

PolarizationType

Type: string

RadioBackendDetail

Name Type Description
description Description
deviceType string
id Radio backend PK
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
radioFilters Array<RadioFilter> Radio filters available on this backend
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

RadioFilter

Name Type Description
id integer Radio filter PK
name Filter name
startFrequencyMhz number Filter lower frequency bound (MHz)
stopFrequencyMhz number Filter upper frequency bound (MHz)

RadioReceiverBand

Type: string

RadioReceiverChannelBackendConnection

Name Type Description
id integer Connection PK
isActive boolean Is active?
radioBackendId integer Radio backend PK
receiverChannelId integer Receiver channel PK

RadioReceiverSummary

Name Type Description
band Receiver band
id integer Receiver PK
maxFrequencyMhz number Maximum frequency (MHz)
minFrequencyMhz number Minimum frequency (MHz)
name string Receiver name

RadioSpectrometerDetail

Name Type Description
antenna Antenna details
antennaId Antenna PK
antennaUid Antenna UID
beamwidth Beamwidth (degrees)
channelBackendConnections Array<RadioReceiverChannelBackendConnection> Receiver channel to backend connections
configurationUpdatedOn string(date-time) Timestamp of last scheduling-relevant configuration update
configurationVersion integer Monotonic scheduling configuration version
id Instrument PK
instrumentType string Radio spectrometer
isActive boolean Is active?
name string Instrument name
receiverIds Receiver PKs
receivers Receivers
receiverSummaries Compact descriptors of the connected receivers
telescope Telescope
telescopeId integer Owning telescope PK
telescopeUid Owning telescope UID
uid string(uuid) Instrument UID

Receiver

Name Type Description
band Receiver band
channels Array<ReceiverChannel> Receiver channels
deviceType string
id integer Receiver PK
imageId Image asset ID for the device.
isAvailable boolean Is receiver available?
manufacturer
maxFrequencyMhz number Maximum frequency (MHz)
minFrequencyMhz number Minimum frequency (MHz)
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

ReceiverChannel

Name Type Description
id integer Receiver channel PK
isActive boolean Is active?
offsetXArcsec number Offset in X (arcsec)
offsetYArcsec number Offset in Y (arcsec)
polarization PolarizationType Polarization type
receiverId integer Receiver PK

ReceiverDetail

Name Type Description
band Receiver band
channels Array<ReceiverChannel> Receiver channels
deviceType string
id integer Receiver PK
imageId Image asset ID for the device.
isAvailable boolean Is receiver available?
manufacturer
maxFrequencyMhz number Maximum frequency (MHz)
minFrequencyMhz number Minimum frequency (MHz)
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintActions Array<OperationalConstraintAction>
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.

RegistrationInvitation

Name Type Description
createdById Entity who created the invitation.
createdOn string(date-time)
email
emailSent boolean
entityId
expiresIn integer
firstName string
id string(uuid)
invitationType string
lastName string
lastSentOn
status InvitationStatus
used boolean

RenderNormalization

Name Type Description
backgroundPercentile number Percentile used for the background level.
midtonePercentile number Percentile used for the midtone level.
saturationPercentile number Percentile used for the saturation level.
stretch string Stretch algorithm to apply.

RenderPalette

Name Type Description
colormap string Colormap name.
invert boolean Whether to invert the colormap.
nan string How to render NaN values.

RenderSettings

Name Type Description
normalization RenderNormalization
rendering RenderPalette
schemaVersion integer Render settings schema version.

SiteSummary

Name Type Description
countryCode string
elevationM number
iauCode
id
latitudeDeg number
location string
longitudeDeg number
name string
owner
ownerId
slug string
uid string(uuid)

SkynetRoleName

Type: string

SkynetStorageType

Type: string

SolveFilterPolicy

Type: string

StreamKind

Type: string

StreamQuality

Type: string

SunAltitudeOpenCondition

Type: string

TargetPositionType

Type: string

TelescopeAccessGrant

Name Type Description
entityId
id integer
revoked boolean
shares number
telescopeId integer
timeContested number
timeUsed number
timeWaiting number

TelescopeAccessGrantInvitation

Name Type Description
createdById Entity who created the invitation.
createdOn string(date-time)
email
emailSent boolean
entityId
expiresIn integer
id string(uuid)
invitationType string
lastSentOn
status InvitationStatus
telescopeAccessGrantId integer
used boolean

TelescopeGalleryItem

Name Type Description
file
fileId string(uuid)
id integer
order
telescopeId integer
visibility boolean

TelescopeLtd

Name Type Description
antennaIds
calibrationObservingAccountId
cameraIds
description
deviceIds
elevationM number
enclosureId
enclosureUid
filterWheelIds
focuserIds
galleryItemIds
iauCode
id
imageId
instrumentIds
ipCameraIds
isAvailable boolean
isPublic boolean
latitudeDeg number
location string
longitudeDeg number
mountId
mountUid
name string
observatoryId integer
observatoryUid
otaIds
ownerId integer
publicLatitudeDeg
publicLongitudeDeg
radioBackendIds
receiverIds
rotatorIds
shortName
slug string
uid string(uuid)

TelescopeSummary

Name Type Description
antennaIds
calibrationObservingAccountId
cameraIds
description
deviceIds
elevationM number
enclosureId
enclosureUid
filterWheelIds
focuserIds
galleryItemIds
iauCode
id
imageId
instrumentIds
ipCameraIds
isAvailable boolean
isPublic boolean
latitudeDeg number
localHorizon
location string
longitudeDeg number
mountId
mountUid
name string
observatory
observatoryId integer
observatoryUid
otaIds
owner
ownerId integer
publicLatitudeDeg
publicLongitudeDeg
radioBackendIds
receiverIds
rotatorIds
shortName
slug string
uid string(uuid)

TelescopeWithCapabilities

Name Type Description
antennaIds
antennas Array<AntennaDetail>
calibrationObservingAccountId
cameraIds
cameras Array<CameraDetail>
description
deviceIds
elevationM number
enclosure
enclosureId
enclosureUid
filterWheelIds
filterWheels Array<FilterWheelDetail>
focuserIds
focusers Array<FocuserDetail>
galleryItemIds
galleryItems
iauCode
id
imageId
instrumentIds
instruments Array<>
ipCameraIds
ipCameras Array<IPCamera>
isAvailable boolean
isPublic boolean
latitudeDeg number
localHorizon
location string
longitudeDeg number
mount
mountId
mountUid
name string
observatory
observatoryId integer
observatoryUid
otaIds
otas Array<OtaDetail>
owner
ownerId integer
publicLatitudeDeg
publicLongitudeDeg
radioBackendIds
radioBackends Array<RadioBackendDetail>
receiverIds
receivers Array<ReceiverDetail>
rotatorIds
rotators Array<InstrumentRotatorDetail>
shortName
slug string
uid string(uuid)

User

Name Type Description
affiliation Affiliation provided by the user in their public profile
age Age of the user
birthdate Birthdate provided by the user in their public profile
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
description Description/Bio provided by the user or organization in their public profile
entityType string
facebookId Facebook ID provided by the user in their public profile
firstName First name of the user
githubId GitHub ID provided by the user in their public profile
id integer Unique identifier of the user/organization.
language Language provided by the user or organization in their public profile
lastName Last name of the user
linkedinId LinkedIn ID provided by the user in their public profile
location Location provided by the user or organization in their public profile
name string Name of the user/organization.
orcidId OAuth-verified ORCID iD shown on the public profile
orcidVerifiedAt When the ORCID iD was verified via OAuth (null = no verified iD)
profileImageId Profile image of the user/organization.
slug string Unique identifier used in URLs referencing the user/organization.
title Title provided by the user in their public profile
twitterId Twitter ID provided by the user in their public profile
username string Username of the user
websiteUrl Website URL provided by the user or organization in their public profile

UserPublic

Name Type Description
affiliation Affiliation provided by the user in their public profile
age Age of the user
birthdate Birthdate provided by the user in their public profile
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
description Description/Bio provided by the user or organization in their public profile
entityType string
facebookId Facebook ID provided by the user in their public profile
firstName First name of the user
githubId GitHub ID provided by the user in their public profile
id integer Unique identifier of the user/organization.
language Language provided by the user or organization in their public profile
lastName Last name of the user
linkedinId LinkedIn ID provided by the user in their public profile
location Location provided by the user or organization in their public profile
name string Name of the user/organization.
orcidId OAuth-verified ORCID iD shown on the public profile
orcidVerifiedAt When the ORCID iD was verified via OAuth (null = no verified iD)
profileImageId Profile image of the user/organization.
slug string Unique identifier used in URLs referencing the user/organization.
title Title provided by the user in their public profile
twitterId Twitter ID provided by the user in their public profile
username string Username of the user
websiteUrl Website URL provided by the user or organization in their public profile

UserSummary

Name Type Description
affiliation Affiliation provided by the user in their public profile
age Age of the user
birthdate Birthdate provided by the user in their public profile
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
description Description/Bio provided by the user or organization in their public profile
entityType string
facebookId Facebook ID provided by the user in their public profile
firstName First name of the user
githubId GitHub ID provided by the user in their public profile
id integer Unique identifier of the user/organization.
language Language provided by the user or organization in their public profile
lastName Last name of the user
linkedinId LinkedIn ID provided by the user in their public profile
location Location provided by the user or organization in their public profile
name string Name of the user/organization.
orcidId OAuth-verified ORCID iD shown on the public profile
orcidVerifiedAt When the ORCID iD was verified via OAuth (null = no verified iD)
profileImageId Profile image of the user/organization.
slug string Unique identifier used in URLs referencing the user/organization.
title Title provided by the user in their public profile
twitterId Twitter ID provided by the user in their public profile
username string Username of the user
websiteUrl Website URL provided by the user or organization in their public profile

UserWithEmail

Name Type Description
affiliation Affiliation provided by the user in their public profile
age Age of the user
birthdate Birthdate provided by the user in their public profile
country Country provided by the user or organization in their public profile
createdOn Creation time of this account
description Description/Bio provided by the user or organization in their public profile
email string Email address of the user
entityType string Type of entity (user/organization)
facebookId Facebook ID provided by the user in their public profile
firstName First name of the user
githubId GitHub ID provided by the user in their public profile
id integer Unique identifier of the user/organization.
language Language provided by the user or organization in their public profile
lastName Last name of the user
linkedinId LinkedIn ID provided by the user in their public profile
location Location provided by the user or organization in their public profile
name string Name of the user/organization.
orcidId OAuth-verified ORCID iD shown on the public profile
orcidVerifiedAt When the ORCID iD was verified via OAuth (null = no verified iD)
profileImageId Profile image of the user/organization.
slug string Unique identifier used in URLs referencing the user/organization.
title Title provided by the user in their public profile
twitterId Twitter ID provided by the user in their public profile
username string Username of the user
websiteUrl Website URL provided by the user or organization in their public profile

ValidationError

Name Type Description
ctx
input
loc Array<>
msg string
type string

WeatherSensor

Name Type Description
deviceType string
hasAmbientTemperature boolean
hasCloudTemperatureDeltaC boolean
hasHumidity boolean
hasLightLevel boolean
hasPressure boolean
hasRainRate boolean
hasRainStorm boolean
hasSurfaceWetness boolean
hasWindDirection boolean
hasWindSpeedAvg10Min boolean
hasWindSpeedAvg1Min boolean
hasWindSpeedAvg2Min boolean
hasWindSpeedInstantaneous boolean
hasWindSpeedPeak10Min boolean
hasWindSpeedPeak1Min boolean
hasWindSpeedPeak2Min boolean
id The unique identifier for the device.
imageId Image asset ID for the device.
manufacturer
modelId
name The name of the device.
observatoryId The observatory ID this device belongs to.
observatoryUid The observatory UID this device belongs to.
operationalConstraintIds Operational constraint PKs
ownerId integer The organization or user which owns the device.
serialNumber Serial number for the device.
telescopeId The telescope ID this device belongs to.
telescopeUid The telescope UID this device belongs to.
uid string(uuid) The unique UID for the device.