# Carbide

> Connect your tools to Carbide with the GraphQL API.

- [Get an API token](https://docs.carbide.work/authentication.md): Generate an organization API key and use it to query Carbide.
- [GraphQL explorer](https://docs.carbide.work/explorer.md): Browse the public schema and run your first query against Carbide.
- [listJobNotes](https://docs.carbide.work/graphql/queries/listJobNotes.md)
- [listRequestNotes](https://docs.carbide.work/graphql/queries/listRequestNotes.md)
- [listRequests](https://docs.carbide.work/graphql/queries/listRequests.md): Requests staff work on, filtered, searched and ordered for the request lists.
- [node](https://docs.carbide.work/graphql/queries/node.md): Retrieves a Node from its global id
- [createJobNote](https://docs.carbide.work/graphql/mutations/createJobNote.md)
- [createRequestNote](https://docs.carbide.work/graphql/mutations/createRequestNote.md)
- [deleteNote](https://docs.carbide.work/graphql/mutations/deleteNote.md)
- [updateNote](https://docs.carbide.work/graphql/mutations/updateNote.md)
- [Address](https://docs.carbide.work/graphql/types/Address.md)
- [Contact](https://docs.carbide.work/graphql/types/Contact.md)
- [CreateJobNoteInput](https://docs.carbide.work/graphql/types/CreateJobNoteInput.md)
- [CreateJobNoteResult](https://docs.carbide.work/graphql/types/CreateJobNoteResult.md): The result of the :create_job_note mutation
- [CreateRequestNoteInput](https://docs.carbide.work/graphql/types/CreateRequestNoteInput.md)
- [CreateRequestNoteResult](https://docs.carbide.work/graphql/types/CreateRequestNoteResult.md): The result of the :create_request_note mutation
- [DeleteNoteResult](https://docs.carbide.work/graphql/types/DeleteNoteResult.md): The result of the :delete_note mutation
- [EstimatorProfile](https://docs.carbide.work/graphql/types/EstimatorProfile.md)
- [MutationError](https://docs.carbide.work/graphql/types/MutationError.md): An error generated by a failed mutation
- [Node](https://docs.carbide.work/graphql/types/Node.md): A relay node
- [Note](https://docs.carbide.work/graphql/types/Note.md)
- [NoteConnection](https://docs.carbide.work/graphql/types/NoteConnection.md): :note connection
- [NoteEdge](https://docs.carbide.work/graphql/types/NoteEdge.md): :note edge
- [OrganizationMembership](https://docs.carbide.work/graphql/types/OrganizationMembership.md)
- [PageInfo](https://docs.carbide.work/graphql/types/PageInfo.md): A relay page info
- [Request](https://docs.carbide.work/graphql/types/Request.md)
- [RequestConnection](https://docs.carbide.work/graphql/types/RequestConnection.md): :request connection
- [RequestEdge](https://docs.carbide.work/graphql/types/RequestEdge.md): :request edge
- [RequestListAcknowledgement](https://docs.carbide.work/graphql/types/RequestListAcknowledgement.md): Whether staff have acknowledged (read) a request.
- [RequestListAcknowledgementFilter](https://docs.carbide.work/graphql/types/RequestListAcknowledgementFilter.md): Filters requests by whether staff acknowledged them.
- [RequestListAppointmentStatus](https://docs.carbide.work/graphql/types/RequestListAppointmentStatus.md): Status of a request's relevant appointment, which its row shows as `relevantAppointmentStatus`: the booked appointment, else the most recent.
- [RequestListAppointmentStatusFilter](https://docs.carbide.work/graphql/types/RequestListAppointmentStatusFilter.md): Filters requests by the status of their relevant appointment, matching the `relevantAppointmentStatus` each row shows.
- [RequestListCsrFilter](https://docs.carbide.work/graphql/types/RequestListCsrFilter.md): Filters requests by the assigned CSR.
- [RequestListCustomerType](https://docs.carbide.work/graphql/types/RequestListCustomerType.md): Residential or commercial request.
- [RequestListCustomerTypeFilter](https://docs.carbide.work/graphql/types/RequestListCustomerTypeFilter.md): Filters requests by customer type.
- [RequestListCustomFieldFilter](https://docs.carbide.work/graphql/types/RequestListCustomFieldFilter.md): Filters requests by their answer to one of the organization's custom fields. Values are strings parsed per field type (numbers, ISO 8601 dates, `true` or `false`); unknown field names and values that do not fit the field type are ignored.
- [RequestListCustomFieldOperator](https://docs.carbide.work/graphql/types/RequestListCustomFieldOperator.md): How a custom field filter compares the request's answer.
- [RequestListDateRangeFilter](https://docs.carbide.work/graphql/types/RequestListDateRangeFilter.md): Filters requests by a date. Bounds are inclusive.
- [RequestListEstimatorFilter](https://docs.carbide.work/graphql/types/RequestListEstimatorFilter.md): Filters requests by the contact's assigned estimator.
- [RequestListFacetOperator](https://docs.carbide.work/graphql/types/RequestListFacetOperator.md): How a facet filter treats its values.
- [RequestListFilters](https://docs.carbide.work/graphql/types/RequestListFilters.md): Filters for `listRequests`. Every field is optional; an omitted field does not filter.
- [RequestListOrder](https://docs.carbide.work/graphql/types/RequestListOrder.md): One ordering for `listRequests`.
- [RequestListOrderDirection](https://docs.carbide.work/graphql/types/RequestListOrderDirection.md): Ordering direction.
- [RequestListOrderField](https://docs.carbide.work/graphql/types/RequestListOrderField.md): A field requests can be ordered by.
- [RequestListRangeOperator](https://docs.carbide.work/graphql/types/RequestListRangeOperator.md): How a date range filter compares the request's date with its bounds.
- [RequestListSource](https://docs.carbide.work/graphql/types/RequestListSource.md): Where a request came from.
- [RequestListSourceFilter](https://docs.carbide.work/graphql/types/RequestListSourceFilter.md): Filters requests by source.
- [RequestListWorkflowStatus](https://docs.carbide.work/graphql/types/RequestListWorkflowStatus.md): Workflow status of a request, as shown in the request lists.
- [RequestListWorkflowStatusFilter](https://docs.carbide.work/graphql/types/RequestListWorkflowStatusFilter.md): Filters requests by workflow status.
- [UpdateNoteInput](https://docs.carbide.work/graphql/types/UpdateNoteInput.md)
- [UpdateNoteResult](https://docs.carbide.work/graphql/types/UpdateNoteResult.md): The result of the :update_note mutation
- [User](https://docs.carbide.work/graphql/types/User.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.