These are the API endpoints for the CitSci Platform. [CitSci.org](https://citsci.org) and our [Mobile Apps](https://citsci.org/apps) consume this API.
The longitude and latitude of the location in WGS 84 format. For example: POINT(30.123 50.456). Future implementation: In the case of polygons, this represents the centroid of the polygon. In the case of lines, this represents the endpoint of the line.
The total number of observations for this location.
The location format type (0=Coordinates; 1=Picklist; 2=Both)
The location auto assign type (1=User; 2=Datasheet)
The date format allowed for the current datasheet.
The history of zooniverse image transfers for this datasheet
Whether the datasheet is published or draft.
Whether the datasheet is public or private
The status of the datasheet. The status can be: - draft: at least one single record is not ready (DatasheetRecord::isReady property is false) or the datasheet name is empty; - published: all the records are ready (DatasheetRecord::isReady property is true) and the name is not empty.
Retrieves a DatasheetLocationResults resource.
The section under which the current record was added.
The label/measurement that represents the current record Can be empty if the record represents an organism (picklist or not) or is related to a measurement/attribute.
Indicates if the current record is valid to be published.
Indicates if the current entry is an "Any Organism" record.
The organisms associated with this record.
Whether the current record can be replicated.
The default value of the datasheet record (not used for dropdown/radio or set data types)
The option set of the datasheet record. It applies for fields like dropdown, radio/multiple choice lists, toggle buttons.
The validators of this datasheet record.
The appearance options of this datasheet record.
The child records of the current record.
Indicates if the datasheet record is active or not.
Retrieves a DatasheetRecordLocationResults resource.
Retrieves a DatasheetRecordResults resource.
The datasheet this history entry belongs to
Retrieves a DatasheetZooniverseHistory resource.
Zooniverse transfer history for a datasheet
The datasheet record the appearance option was created for
Retrieves a FieldAppearanceOption resource.
The field the validator was created for.
Indicates if the notification has been read or not
Retrieves a NotificationPreference resource.
Updates the NotificationPreference resource.
The datasheet used to create this observation.
The observers that recorded this observation.
The observer that registered the observation.
Retrieves a ObservationObserver resource.
A relation between observation and user.
The datasheet record from which the current one was created.
The observation the record was created for.
Whether the observation record is public or private
The organism associated with this record (if the record represents an organism).
The children records of the current record
The files associated with this observation record
The value of the options set value selected for this record. This will be null for the records that have no options set.
The option values selected for multiselect This will be null for the records that are not multi select
Retrieves a ObservationResource resource.
The position of the choice in the data set.
Indicates if the value is the default one or not. The data set can have no default value.
Indicates if the current option must define a custom value for the dataset.
The options set this option value belongs to.
Indicates if the options set allows a custom value.
The datasheet record associated with this data set.
An organism (GBIF Backbone Taxonomy) Partial pagination prevents long query times of counting all 5 million organisms, also istart is a little faster than ipartial
The projects belonging to this organization
Do project affiliations require approval?
The member role. Accepted roles: "manager" "member" The user can have one single role per organization at any time.
Whether the member role was approved or not.
The date when the member role was approved.
Retrieves a OrganizationMember resource.
Retrieves a OrganizationProject resource.
Updates the OrganizationProject resource.
The organization this resource was added to.
Retrieves a OrganizationResource resource.
Replaces the OrganizationResource resource.
Deletes the OrganizationResource resource.
Indicates if the project is active or not.
Indicates if the project is private or public.
Indicates if the project has open or closed membership.
The project status <draft|published|etc...>
Indicates if the project should be published on project
Indicates if the project should be published on SciStarter
Indicates the corresponding published SciStarter project id.
The SciStarter URL slug returned in the API reply.
Whether the manager has shared their Airtable Auth with this project
The datasheets created for this project.
The total number of measurements of the project.
The organizations this project belongs to
The topics associated with this project, stored as a json object
The date the last observation was submitted to this project
The project this history entry belongs to
The Base where data is sent to at Airtable
The existing table where data is sent to at Airtable
The new table name where data is to be sent at Airtable
The status of the job Accepted statuses: "submitted" "in progress" "completed" "failed"
The time in seconds it took the job to complete/fail from a DB processing standpoint.
Retrieves a ProjectAirtableHistory resource.
The type of the download job Accepted types: "flat" "hierarchical"
The status of the download job Accepted status: "submitted" "in progress" "completed" "failed"
Indicates if a project is liked by a user or not
Retrieves a ProjectLocationDatasheetUsage resource.
The member role. Accepted roles: "manager" "member" The user can have one single role per project at the time.
Whether the member role was approved or not. The owner of the project will be automatically approved as manager. TODO: the members that are not approved in a specific time frame (e.g. 72 hours) should be automatically removed.
The date when the member role was approved. The owner of the project will be automatically approved as manager.
Whether the member is a zooniverse collaborator The member has to be a manager
Retrieves a ProjectMemberInvite resource.
Deletes the ProjectMemberInvite resource.
A project member invitation // TODO: Automatically remove the expired member invites from DB.
Retrieves a ProjectMemberLocation resource.
Deletes the ProjectMemberLocation resource.
The description field of the project post
The tags associated with this forum post stored as a json object
Indicates if the members are going to be notified of this forum post.
The files associated with this project post
The tags associated with this project resource stored as a json object
A project resource (file, link or map layer)
The project the history was requested for.
The type of the synchronization Accepted types:
The status of the history Accepted status: "submitted" "in progress" "completed" "failed"
The time in seconds it took the sync to complete/fail.
Retrieves a ProjectSciStarterHistory resource.
Retrieves a ProjectSubresourceTags resource.
The organism associated with the record.
The scientific name of the organism. TODO: the GBIF DB was explained later. The rigth scientific name for CitSci is the DB canonical name.
The canonical name of the organism. TODO: this variable was used in a wrong way in the past, the GBIF DB was explained later. This is used as the common name.
A relation between organism and datasheet/observation record
The organization this scorecard belongs to
The datasheet record this scorecard is tied to
The type of the scorecard (numerical | categorical)
The total of measurements (observation records).
Indicates if the user email was verified
User display name based on their privacy setting
The projects this user created or is a part of.
The organizations this user is a manager of
If the user wants to receive the newsletter.
Returns if user has even authorized with Airtable
Returns if the Airtable Refresh token has expired
Retrieves the collection of Area resources.
Retrieves the collection of Datasheet resources.
The collection of DatasheetRecord resources
Retrieves the collection of DatasheetRecord resources.
The collection of DatasheetZooniverseHistory resources
Retrieves the collection of DatasheetZooniverseHistory resources.
Retrieves the collection of FileObject resources.
The collection of Notification resources
Retrieves the collection of Notification resources.
The collection of NotificationPreference resources
Creates a NotificationPreference resource.
Retrieves the collection of NotificationPreference resources.
Retrieves the collection of Observation resources.
The collection of ObservationRecord resources
Retrieves the collection of Organism resources.
The collection of Organization resources
Retrieves the collection of Organization resources.
The collection of OrganizationMember resources
Retrieves the collection of OrganizationMember resources.
The collection of OrganizationProject resources
Retrieves the collection of OrganizationProject resources.
The collection of OrganizationResource resources
Creates a OrganizationResource resource.
Retrieves the collection of OrganizationResource resources.
Retrieves the collection of Project resources.
The collection of ProjectAirtableHistory resources
Creates a ProjectAirtableHistory resource.
Retrieves the collection of ProjectAirtableHistory resources.
The collection of ProjectDownload resources
Retrieves the collection of ProjectDownload resources.
The collection of ProjectMember resources
Retrieves the collection of ProjectMember resources.
The collection of ProjectMemberInvite resources
Retrieves the collection of ProjectMemberInvite resources.
The collection of ProjectMemberLocation resources
Creates a ProjectMemberLocation resource.
Retrieves the collection of ProjectMemberLocation resources.
Retrieves the collection of ProjectPost resources.
The collection of ProjectResource resources
Retrieves the collection of ProjectResource resources.
The collection of ProjectSciStarterHistory resources
Retrieves the collection of ProjectSciStarterHistory resources.
The collection of RecordOrganism resources
Retrieves the collection of RecordOrganism resources.
Retrieves the collection of Scorecard resources.
Retrieves the collection of Stat resources.
Retrieves the collection of Topics resources.
Retrieves the collection of User resources.
The message associated with the violation