# Cirqll Core ## Docs - [Getting Started](https://docs.api.cirqll.nl/getting-started.md): - [Translations](https://docs.api.cirqll.nl/translations.md): - Documentation [Field Values](https://docs.api.cirqll.nl/field-values.md): - Documentation [Rate Limiting](https://docs.api.cirqll.nl/rate-limiting.md): - Documentation [Zapier](https://docs.api.cirqll.nl/zapier.md): - Documentation > Zapier [Triggers](https://docs.api.cirqll.nl/zapier-triggers.md): - Documentation > Zapier [Actions](https://docs.api.cirqll.nl/zapier-actions.md): - Documentation [Query Parameters](https://docs.api.cirqll.nl/queries.md): - Documentation > Query Parameters [Eager Loading](https://docs.api.cirqll.nl/eager.md): - Documentation > Query Parameters [Partial Data](https://docs.api.cirqll.nl/partial.md): - Documentation > Query Parameters [Count Relations](https://docs.api.cirqll.nl/count.md): - Documentation > Query Parameters [Filter](https://docs.api.cirqll.nl/filter.md): - Documentation > Query Parameters [Order By](https://docs.api.cirqll.nl/order.md): - Documentation > Query Parameters [Pagination](https://docs.api.cirqll.nl/pagination.md): - Documentation [OAuth2](https://docs.api.cirqll.nl/oauth2.md): - [User](https://docs.api.cirqll.nl/api-user.md): Contains all CRUD operations allowed for Assignments - [Role](https://docs.api.cirqll.nl/api-role.md): Contains all CRUD operations allowed for Assignments - [Customer](https://docs.api.cirqll.nl/api-customer.md): - [Contact](https://docs.api.cirqll.nl/api-contact.md): Contains all CRUD operations allowed for contracts - [Task](https://docs.api.cirqll.nl/api-task.md): - [Appointment](https://docs.api.cirqll.nl/api-appointment.md): Contains all CRUD operations allowed for Assignments - [Financial](https://docs.api.cirqll.nl/api-financial.md): - Financial [Chance](https://docs.api.cirqll.nl/api-chance.md): Contains all CRUD operations allowed for chances - Financial [Assignment](https://docs.api.cirqll.nl/api-assignment.md): Contains all CRUD operations allowed for Assignments - Financial [Contract](https://docs.api.cirqll.nl/api-contract.md): Contains all CRUD operations allowed for contracts - [Email](https://docs.api.cirqll.nl/api-email.md): - [Field](https://docs.api.cirqll.nl/api-field.md): - [Note](https://docs.api.cirqll.nl/api-note.md): - [Todo](https://docs.api.cirqll.nl/api-todo.md): - [Template](https://docs.api.cirqll.nl/api-template.md): - [Setting](https://docs.api.cirqll.nl/api-settings.md): - [Webhook](https://docs.api.cirqll.nl/api-webhook.md): ## API Docs - Documentation > OAuth2 > Token [Token Create - Cirqll Core](https://docs.api.cirqll.nl/oauth2/token.md): Exchange OAuth2 credentials (client ID, secret, and grant type) for an access token and refresh token. - Documentation > OAuth2 > Token [Token Refresh - Cirqll Core](https://docs.api.cirqll.nl/oauth2/token/refresh.md): Exchange a refresh token for a new access token. Use this to obtain a fresh token without requiring the user to log in again. - Documentation > OAuth2 [OAuth2 Scopes - Cirqll Core](https://docs.api.cirqll.nl/oauth2/scopes.md): Retrieve all available OAuth2 scopes. Scopes define what resources and actions an access token is permitted to use. - Documentation > OAuth2 [Authorize - Cirqll Core](https://docs.api.cirqll.nl/authorize.md): Authorize — GET /authorize - User [User Me - Cirqll Core](https://docs.api.cirqll.nl/user/me.md): Retrieve the full profile of the currently authenticated user, including roles and permissions. - User [User Index - Cirqll Core](https://docs.api.cirqll.nl/user/index.md): List all users in your organisation. Supports filtering and sorting. - User [User Show - Cirqll Core](https://docs.api.cirqll.nl/user/show.md): Retrieve a single user by their unique ID. - User [User Create - Cirqll Core](https://docs.api.cirqll.nl/user/create.md): Invite and create a new user account in your organisation. Creating a user may incur a cost — see the pricing page. - User [User Update - Cirqll Core](https://docs.api.cirqll.nl/user/update.md): Update an existing user's profile, role, or settings. - User [User Delete - Cirqll Core](https://docs.api.cirqll.nl/user/delete.md): Remove a user from your organisation. Their data will be retained but access will be revoked. - Role [Role Index - Cirqll Core](https://docs.api.cirqll.nl/role/index.md): List all roles defined in your organisation. Roles control what each user is allowed to see and do. - Role [Role Show - Cirqll Core](https://docs.api.cirqll.nl/role/show.md): Retrieve a single role by its unique ID, including its permission set. - Role [Role Create - Cirqll Core](https://docs.api.cirqll.nl/role/create.md): Create a new role with a custom set of permissions - Role [Role Update - Cirqll Core](https://docs.api.cirqll.nl/role/update.md): Update an existing role's name or permission set. - Role [Role Delete - Cirqll Core](https://docs.api.cirqll.nl/role/delete.md): Delete a role. Users assigned to this role must be reassigned before deletion. - Customer [Customer Index - Cirqll Core](https://docs.api.cirqll.nl/customer/index.md): List all customers in your CRM. Supports filtering, sorting, and pagination. Commonly used to power customer overviews and search. - Customer [Customer Show - Cirqll Core](https://docs.api.cirqll.nl/customer/show.md): Retrieve a single customer by their unique ID, including related data such as contacts, notes, and custom field values. - Customer [Customer Create - Cirqll Core](https://docs.api.cirqll.nl/customer/create.md): Create a new customer record. Custom field values can be provided at creation time. - Customer [Customer Update - Cirqll Core](https://docs.api.cirqll.nl/customer/update.md): Update an existing customer's details. Only the fields you provide will be changed. - Customer [Customer Delete - Cirqll Core](https://docs.api.cirqll.nl/customer/delete.md): Delete a customer record. Use the Undo Last Action endpoint to reverse accidental deletions. - Contact [Contact Index - Cirqll Core](https://docs.api.cirqll.nl/contact/index.md): List all contacts. Typically filtered by customer ID to retrieve the contacts belonging to a specific customer. - Contact [Contact Show - Cirqll Core](https://docs.api.cirqll.nl/contact/show.md): Retrieve a single contact by their unique ID. - Contact [Contact Create - Cirqll Core](https://docs.api.cirqll.nl/contact/create.md): Create a new contact and associate it with a customer. - Contact [Contact Update - Cirqll Core](https://docs.api.cirqll.nl/contact/update.md): Update an existing contact's details such as name, email, phone, or custom field values. - Contact [Contact Delete - Cirqll Core](https://docs.api.cirqll.nl/contact/delete.md): Delete a contact record permanently. - Task [Task Index - Cirqll Core](https://docs.api.cirqll.nl/task/index.md): List all tasks. Supports filtering by date, assignee, or linked customer. - Task [Task Show - Cirqll Core](https://docs.api.cirqll.nl/task/show.md): Retrieve a single task by its unique ID, including subtasks and custom field values. - Task [Task Create - Cirqll Core](https://docs.api.cirqll.nl/task/create.md): Create a new task. Tasks can be linked to customers and assigned to users. - Task [Task Update - Cirqll Core](https://docs.api.cirqll.nl/task/update.md): Update a task's title, linked customer, due date, assignee, or custom field values. - Task [Task Delete - Cirqll Core](https://docs.api.cirqll.nl/task/delete.md): Delete a task and all of its subtasks. - Appointment [Appointment Index - Cirqll Core](https://docs.api.cirqll.nl/appointment/index.md): List all appointments. Supports filtering by date range, user, or customer for calendar and overview use cases. - Appointment [Appointment Show - Cirqll Core](https://docs.api.cirqll.nl/appointment/show.md): Retrieve a single appointment by its unique ID. - Appointment [Appointment Create - Cirqll Core](https://docs.api.cirqll.nl/appointment/create.md): Schedule a new appointment. Appointments can be linked to customers, contacts, and synced to Microsoft Outlook or Google Calendar. - Appointment [Appointment Update - Cirqll Core](https://docs.api.cirqll.nl/appointment/update.md): Update an existing appointment's time, participants, or details. - Appointment [Appointment Delete - Cirqll Core](https://docs.api.cirqll.nl/appointment/delete.md): Cancel and delete an appointment - Financial > Chance [Chance Index - Cirqll Core](https://docs.api.cirqll.nl/chance/index.md): List all chances (sales opportunities) in the pipeline. Supports filtering by stage, value, or linked customer. - Financial > Chance [Chance Show - Cirqll Core](https://docs.api.cirqll.nl/chance/show.md): Retrieve a single chance by its unique ID. - Financial > Chance [Chance Create - Cirqll Core](https://docs.api.cirqll.nl/chance/create.md): Create a new chance (sales opportunity) and link it to a customer. - Financial > Chance [Chance Update - Cirqll Core](https://docs.api.cirqll.nl/chance/update.md): Update a chance's stage, expected value, close date, or custom field values. - Financial > Chance [Chance Delete - Cirqll Core](https://docs.api.cirqll.nl/chance/delete.md): Delete a chance record permanently. - Financial > Assignment [Assignment Index - Cirqll Core](https://docs.api.cirqll.nl/assignment/index.md): List all assignments. Assignments represent work items or deliverables that which have a direct profit. - Financial > Assignment [Assignment Show - Cirqll Core](https://docs.api.cirqll.nl/assignment/show.md): Retrieve a single assignment by its unique ID, including attached media. - Financial > Assignment [Assignment Create - Cirqll Core](https://docs.api.cirqll.nl/assignment/create.md): Create a new assignment. - Financial > Assignment [Assignment Update - Cirqll Core](https://docs.api.cirqll.nl/assignment/update.md): Update an existing assignment's details or custom field values. - Financial > Assignment [Assignment Delete - Cirqll Core](https://docs.api.cirqll.nl/assignment/delete.md): Delete an assignment and all of its attached media. - Financial > Contract [Contract Index - Cirqll Core](https://docs.api.cirqll.nl/contract/index.md): List all contracts. Supports filtering by archive status, customer, or date range. - Financial > Contract [Contract Show - Cirqll Core](https://docs.api.cirqll.nl/contract/show.md): Retrieve a single contract by its unique ID. - Financial > Contract [Contract Create - Cirqll Core](https://docs.api.cirqll.nl/contract/create.md): Create a new contract and associate it with a customer. - Financial > Contract [Contract Update - Cirqll Core](https://docs.api.cirqll.nl/contract/update.md): Update an existing contract's details like dates and custom field values. - Financial > Contract [Contract Delete - Cirqll Core](https://docs.api.cirqll.nl/contract/delete.md): Delete a contract record permanently. - Email [Email Index - Cirqll Core](https://docs.api.cirqll.nl/email/index.md): List all emails tracked in the CRM. Emails are typically linked to a customer but could be unlinked. - Email [Email Show - Cirqll Core](https://docs.api.cirqll.nl/email/show.md): Retrieve a single email by its unique ID. - Email [Email Create - Cirqll Core](https://docs.api.cirqll.nl/email/create.md): Log or send a new email and associate it with a customer. - Email [Email Update - Cirqll Core](https://docs.api.cirqll.nl/email/update.md): Update the metadata or content of an existing email record. - Email [Email Delete - Cirqll Core](https://docs.api.cirqll.nl/email/delete.md): Delete an email record from the CRM. - Field [Field Index - Cirqll Core](https://docs.api.cirqll.nl/field/index.md): List all custom field definitions. Custom fields can be attached to customers, contacts, tasks, appointments, and financial records. - Field [Field Show - Cirqll Core](https://docs.api.cirqll.nl/field/show.md): Retrieve a single custom field definition by its unique ID, including its type and options. - Field [Field Create - Cirqll Core](https://docs.api.cirqll.nl/field/create.md): Create a new custom field definition. Supported types: text, select, date, yesno, price, multiselect, labels, url. - Field [Field Update - Cirqll Core](https://docs.api.cirqll.nl/field/update.md): Update a custom field's label, options, or configuration. - Field [Field Delete - Cirqll Core](https://docs.api.cirqll.nl/field/delete.md): Delete a custom field definition. All stored values for this field will also be removed. - Note [Note Index - Cirqll Core](https://docs.api.cirqll.nl/note/index.md): List all notes. Notes are free-text annotations which are attached to customers, and optionally contacts, and other records. - Note [Note Show - Cirqll Core](https://docs.api.cirqll.nl/note/show.md): Retrieve a single note by its unique ID. - Note [Note Create - Cirqll Core](https://docs.api.cirqll.nl/note/create.md): Create a new note and attach it to a customer. - Note [Note Update - Cirqll Core](https://docs.api.cirqll.nl/note/update.md): Update the content of an existing note. - Note [Note Delete - Cirqll Core](https://docs.api.cirqll.nl/note/delete.md): Delete a note permanently. - Todo [Todo Index - Cirqll Core](https://docs.api.cirqll.nl/todo/index.md): List all to-do items for the authenticated user. - Todo [Todo Show - Cirqll Core](https://docs.api.cirqll.nl/todo/show.md): Retrieve a single to-do item by its unique ID. - Todo [Todo Create - Cirqll Core](https://docs.api.cirqll.nl/todo/create.md): Create a new to-do item. - Todo [Todo Update - Cirqll Core](https://docs.api.cirqll.nl/todo/update.md): Update a to-do item's title, due date, or completion status. - Todo [Todo Delete - Cirqll Core](https://docs.api.cirqll.nl/todo/delete.md): Delete a to-do item. - Template [Template Index - Cirqll Core](https://docs.api.cirqll.nl/template/index.md): List all templates. Templates can be used to pre-populate records like tasks. - Template [Template Show - Cirqll Core](https://docs.api.cirqll.nl/template/show.md): Retrieve a single template by its unique ID. - Template [Template Create - Cirqll Core](https://docs.api.cirqll.nl/template/create.md): Create a new template. - Template [Template Update - Cirqll Core](https://docs.api.cirqll.nl/template/update.md): Update an existing template's content or configuration. - Template [Template Delete - Cirqll Core](https://docs.api.cirqll.nl/template/delete.md): Delete a template permanently. - Setting [Setting Index - Cirqll Core](https://docs.api.cirqll.nl/setting/index.md): Retrieve the settings for the currently authenticated user, including notification preferences and display options. - Setting [Setting Update - Cirqll Core](https://docs.api.cirqll.nl/setting/update.md): Update one or more settings for the currently authenticated user. - Webhook [Webhook Index - Cirqll Core](https://docs.api.cirqll.nl/webhook/index.md): List all outbound webhook subscriptions configured in your organisation. - Webhook [Webhook Show - Cirqll Core](https://docs.api.cirqll.nl/webhook/show.md): Retrieve a single webhook subscription by its unique ID. - Webhook [Webhook Create - Cirqll Core](https://docs.api.cirqll.nl/webhook/create.md): Register a new outbound webhook. Cirqll will POST a payload to your URL when the subscribed event fires. - Webhook [Webhook Update - Cirqll Core](https://docs.api.cirqll.nl/webhook/update.md): Update a webhook's target URL, secret, or event subscriptions. - Webhook [Webhook Delete - Cirqll Core](https://docs.api.cirqll.nl/webhook/delete.md): Delete a webhook subscription. No further events will be sent to the target URL. ## Schemas - Schemas > ActivityLog [ActivityLogResponse](https://docs.api.cirqll.nl/schema-776379.md): - Schemas > ActivityLog [ActivityLogRequestStore](https://docs.api.cirqll.nl/schema-776380.md): - Schemas > ActivityLog [ActivityLogRequestUpdate](https://docs.api.cirqll.nl/schema-776381.md): - Schemas > Address [AddressResponse](https://docs.api.cirqll.nl/schema-776382.md): - Schemas > Address [AddressRequestStore](https://docs.api.cirqll.nl/schema-776383.md): - Schemas > Address [AddressRequestUpdate](https://docs.api.cirqll.nl/schema-776384.md): - Schemas > Appointment [AppointmentResponse](https://docs.api.cirqll.nl/schema-776385.md): - Schemas > Appointment [AppointmentRequestStore](https://docs.api.cirqll.nl/schema-776386.md): - Schemas > Appointment [AppointmentRequestUpdate](https://docs.api.cirqll.nl/schema-776387.md): - Schemas > Assignment [AssignmentResponse](https://docs.api.cirqll.nl/schema-776388.md): - Schemas > Assignment [AssignmentRequestStore](https://docs.api.cirqll.nl/schema-776389.md): - Schemas > Assignment [AssignmentRequestUpdate](https://docs.api.cirqll.nl/schema-776390.md): - Schemas > Chance [ChanceResponse](https://docs.api.cirqll.nl/schema-776395.md): - Schemas > Chance [ChanceRequestStore](https://docs.api.cirqll.nl/schema-776396.md): - Schemas > Chance [ChanceRequestUpdate](https://docs.api.cirqll.nl/schema-776397.md): - Schemas > Client [ClientResponse](https://docs.api.cirqll.nl/schema-776398.md): - Schemas > Client [ClientRequestStore](https://docs.api.cirqll.nl/schema-776399.md): - Schemas > Client [ClientRequestUpdate](https://docs.api.cirqll.nl/schema-776400.md): - Schemas > Company [CompanyResponse](https://docs.api.cirqll.nl/schema-776401.md): - Schemas > Company [CompanyRequestStore](https://docs.api.cirqll.nl/schema-776402.md): - Schemas > Company [CompanyRequestUpdate](https://docs.api.cirqll.nl/schema-776403.md): - Schemas > Contact [ContactResponse](https://docs.api.cirqll.nl/schema-776404.md): - Schemas > Contact [ContactRequestStore](https://docs.api.cirqll.nl/schema-776405.md): - Schemas > Contact [ContactRequestUpdate](https://docs.api.cirqll.nl/schema-776406.md): - Schemas > Contract [ContractResponse](https://docs.api.cirqll.nl/schema-776407.md): - Schemas > Contract [ContractRequestStore](https://docs.api.cirqll.nl/schema-776408.md): - Schemas > Contract [ContractRequestUpdate](https://docs.api.cirqll.nl/schema-776409.md): - Schemas > Customer [CustomerResponse](https://docs.api.cirqll.nl/schema-776410.md): - Schemas > Customer [CustomerRequestStore](https://docs.api.cirqll.nl/schema-776411.md): - Schemas > Customer [CustomerRequestUpdate](https://docs.api.cirqll.nl/schema-776412.md): - Schemas > Email [EmailResponse](https://docs.api.cirqll.nl/schema-776413.md): - Schemas > Email [EmailRequestStore](https://docs.api.cirqll.nl/schema-776414.md): - Schemas > Email [EmailRequestUpdate](https://docs.api.cirqll.nl/schema-776415.md): - Schemas > Field [FieldResponse](https://docs.api.cirqll.nl/schema-776422.md): - Schemas > Field [FieldRequestStore](https://docs.api.cirqll.nl/schema-776423.md): - Schemas > Field [FieldRequestUpdate](https://docs.api.cirqll.nl/schema-776424.md): - Schemas > FieldOption [FieldOptionResponse](https://docs.api.cirqll.nl/schema-776425.md): - Schemas > FieldOption [FieldOptionRequestStore](https://docs.api.cirqll.nl/schema-776426.md): - Schemas > FieldOption [FieldOptionRequestUpdate](https://docs.api.cirqll.nl/schema-776427.md): - Schemas > FieldValue [FieldValueResponse](https://docs.api.cirqll.nl/schema-776428.md): - Schemas > FieldValue [FieldValueRequestStore](https://docs.api.cirqll.nl/schema-776429.md): - Schemas > FieldValue [FieldValueRequestUpdate](https://docs.api.cirqll.nl/schema-776430.md): - Schemas > Media [MediaResponse](https://docs.api.cirqll.nl/schema-776433.md): - Schemas > Media [MediaRequestStore](https://docs.api.cirqll.nl/schema-776434.md): - Schemas > Media [MediaRequestUpdate](https://docs.api.cirqll.nl/schema-776435.md): - Schemas > Note [NoteResponse](https://docs.api.cirqll.nl/schema-776436.md): - Schemas > Note [NoteRequestStore](https://docs.api.cirqll.nl/schema-776437.md): - Schemas > Note [NoteRequestUpdate](https://docs.api.cirqll.nl/schema-776438.md): - Schemas > Origin [OriginResponse](https://docs.api.cirqll.nl/schema-776439.md): - Schemas > Origin [OriginRequestStore](https://docs.api.cirqll.nl/schema-776440.md): - Schemas > Origin [OriginRequestUpdate](https://docs.api.cirqll.nl/schema-776441.md): - Schemas > Permission [PermissionsResponse](https://docs.api.cirqll.nl/schema-776442.md): - Schemas > Permission [PermissionsRequestStore](https://docs.api.cirqll.nl/schema-776443.md): - Schemas > Permission [PermissionsRequestUpdate](https://docs.api.cirqll.nl/schema-776444.md): - Schemas > Role [RoleResponse](https://docs.api.cirqll.nl/schema-776445.md): - Schemas > Role [RoleRequestStore](https://docs.api.cirqll.nl/schema-776446.md): - Schemas > Role [RoleRequestUpdate](https://docs.api.cirqll.nl/schema-776447.md): - Schemas > Scope [ScopeResponse](https://docs.api.cirqll.nl/schema-776448.md): - Schemas > Scope [ScopeRequestStore](https://docs.api.cirqll.nl/schema-776449.md): - Schemas > Scope [ScopeRequestUpdate](https://docs.api.cirqll.nl/schema-776450.md): - Schemas > Settings [SettingsResponse](https://docs.api.cirqll.nl/schema-776451.md): - Schemas > Settings [SettingsRequestStore](https://docs.api.cirqll.nl/schema-776452.md): - Schemas > Settings [SettingsRequestUpdate](https://docs.api.cirqll.nl/schema-776453.md): - Schemas > Subtask [SubtaskRequestUpdate](https://docs.api.cirqll.nl/schema-776454.md): - Schemas > Subtask [SubtaskRequestStore](https://docs.api.cirqll.nl/schema-776455.md): - Schemas > Subtask [SubtaskResponse](https://docs.api.cirqll.nl/schema-776456.md): - Schemas > Task [TaskResponse](https://docs.api.cirqll.nl/schema-776460.md): - Schemas > Task [TaskRequestStore](https://docs.api.cirqll.nl/schema-776461.md): - Schemas > Task [TaskRequestUpdate](https://docs.api.cirqll.nl/schema-776462.md): - Schemas > Template [TemplateResponse](https://docs.api.cirqll.nl/schema-776466.md): - Schemas > Template [TemplateRequestStore](https://docs.api.cirqll.nl/schema-776467.md): - Schemas > Template [TemplateRequestUpdate](https://docs.api.cirqll.nl/schema-776468.md): - Schemas > TemplateItem [TemplateItemResponse](https://docs.api.cirqll.nl/schema-776469.md): - Schemas > TemplateItem [TemplateItemRequestStore](https://docs.api.cirqll.nl/schema-776470.md): - Schemas > TemplateItem [TemplateItemRequestUpdate](https://docs.api.cirqll.nl/schema-776471.md): - Schemas > Todo [TodoResponse](https://docs.api.cirqll.nl/schema-776472.md): - Schemas > Todo [TodoRequestStore](https://docs.api.cirqll.nl/schema-776473.md): - Schemas > Todo [TodoRequestUpdate](https://docs.api.cirqll.nl/schema-776474.md): - Schemas > User [UserResponse](https://docs.api.cirqll.nl/schema-776475.md): - Schemas > User [UserRequestStore](https://docs.api.cirqll.nl/schema-776476.md): - Schemas > User [UserRequestUpdate](https://docs.api.cirqll.nl/schema-776477.md): - Schemas > Webhook [WebhookResponse](https://docs.api.cirqll.nl/schema-776478.md): - Schemas > Webhook [WebhookRequestStore](https://docs.api.cirqll.nl/schema-776479.md): - Schemas > Webhook [WebhookRequestUpdate](https://docs.api.cirqll.nl/schema-776480.md): - Structure [Paginate](https://docs.api.cirqll.nl/schema-687104.md): - Structure [Exception](https://docs.api.cirqll.nl/schema-687105.md):