# Authentication setup

Welcome to the RogerRoger API

The RogerRoger API gives you the foundation to create custom integrations and share data with other platforms, letting you sync contacts,  generate tasks, or run automations with ease.

To get started, you need:

1. An active RogerRoger subscription
2. An administrator account
3. An API key  ([create an API key here](https://app.rogerroger.io/admin/api))

#### Authentication and connection with API keys

RogerRoger only supports API key authentication. You can view and manage your API keys in the RogerRoger admin. We recommend starting with a simple GET call:

```
// Get all people
curl -X GET "https://api.rogerroger.io/people"
  -H "X-API-KEY: YOUR_API_KEY"
```

{% hint style="success" %}
The API key needs to be passed as a header in every API call you make.
{% endhint %}

All API requests must be made over HTTPS.

* Calls made over plain HTTP will fail.
* API requests without authentication will also fail.

{% hint style="warning" %}
Your API key carries many privileges, so be sure to keep it confidential! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
{% endhint %}


# Rate limits

Request limits and error handling

To ensure stable performance and prevent misuse, our API enforces a rate limit per tenant, regardless of how many API keys a tenant uses.

#### How it works

* Each tenant is allowed up to 20 API requests per minute, across all their API keys combined.
* We use a sliding window strategy:
  * The system continuously tracks the number of requests made by a tenant over the last 60 seconds.
  * Requests are allowed as long as the tenant has not exceeded the 20-request limit within that moving window.
  * As soon as an older request drops out of the window, a new request is allowed.

#### Limit details

| Setting       | Value                   |
| ------------- | ----------------------- |
| Scope         | Per tenant              |
| Shared across | All API keys per tenant |
| Limit         | 20 request              |
| Window        | 1 minute (sliding)      |

#### When limit is exceeded

If a tenant exceeds the limit:

* The API responds with **HTTP 429 – Too Many Requests**.
* A `Retry-After` header is included in the response, indicating how long to wait before retrying.

#### Best practices

* Distribute requests evenly rather than sending many in bursts.
* If you receive a 429 error, pause requests based on the `Retry-After` header before retrying.
* Design your integration with automatic retry logic (e.g. exponential backoff) to handle throttling gracefully.


# Error handling

How to handle response codes

The API returns standard HTTP status codes to indicate success or failure:

* `200 OK` – Request succeeded
* `201 Created` – Resource successfully created
* `400 Bad Request` – Invalid input or parameters
* `401 Unauthorized` – Missing or invalid API key
* `403 Forbidden` – You don't have permission to perform this action
* `404 Not Found` – Resource does not exist
* `429 Too Many Requests` – Rate limit exceeded
* `500 Internal Server Error` – Something went wrong on our end

Error responses include a JSON payload with a `message` field explaining what went wrong. Make sure your integration handles these errors gracefully and logs or displays useful feedback to users where appropriate.


# Pagination

How to handle results

Some API responses—especially those returning lists such as contacts, tasks, or messages—may be paginated. When pagination is applied, the response will include metadata indicating the current page, total items, and a cursor or page token for fetching the next set of results.

Be sure to check for this metadata and follow pagination links or use tokens to retrieve additional data.

```json
// Part of the GET /people response: page 1 of 45

"view": {
        "@id": "/people?page=1",
        "@type": "PartialCollectionView",
        "first": "/people?page=1",
        "last": "/people?page=45",
        "next": "/people?page=2"
 }
```


# People

The people endpoint gives access to the **people** in the CRM.

Good to know:

* A person must always contain a familyname

## Create a new person

> Creates a person with emails, phone numbers, and metadata.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Person.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}],"description":"Represents a CRM contact person with details like name, email, phone, and tags."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/people":{"post":{"operationId":"api_people_post","tags":["Person"],"responses":{"201":{"description":"Person resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create a new person","description":"Creates a person with emails, phone numbers, and metadata.","parameters":[],"requestBody":{"description":"The new Person resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}},"required":true}}}}}
```

## List people

> Retrieve a paginated list of people.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Person.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}],"description":"Represents a CRM contact person with details like name, email, phone, and tags."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/people":{"get":{"operationId":"api_people_get_collection","tags":["Person"],"responses":{"200":{"description":"Person collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Person.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Person.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Person"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"List people","description":"Retrieve a paginated list of people.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"q","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"owner.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"owner.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"emailAddresses.email","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"emailAddresses.email[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"tags.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"tags.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"segments.uuid","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"segments.uuid[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"exists[archivedAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"order[familyName]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"identifiers","in":"query","description":"Filter by identifiers (searches LinkedIn IDs, email addresses, and phone numbers)","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"identifiers[]","in":"query","description":"Filter by multiple identifiers","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"view","in":"query","description":"Filter parameter to specify the view. To get only UUIDs, use 'idx'.","required":false,"deprecated":false,"schema":{"type":"string","enum":["idx"]},"style":"form","explode":false}]}}}}
```

## Retrieve a person

> Get a single person by ID.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Person.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}],"description":"Represents a CRM contact person with details like name, email, phone, and tags."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/people/{id}":{"get":{"operationId":"api_people_id_get","tags":["Person"],"responses":{"200":{"description":"Person resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieve a person","description":"Get a single person by ID.","parameters":[{"name":"id","in":"path","description":"Person identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Update a person

> Replaces all fields of a person.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Person.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}],"description":"Represents a CRM contact person with details like name, email, phone, and tags."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/people/{id}":{"put":{"operationId":"api_people_id_put","tags":["Person"],"responses":{"200":{"description":"Person resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Update a person","description":"Replaces all fields of a person.","parameters":[{"name":"id","in":"path","description":"Person identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Person resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}},"required":true}}}}}
```

## Partially update a person

> Updates specific fields of an existing person.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Person.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}],"description":"Represents a CRM contact person with details like name, email, phone, and tags."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Person.jsonMergePatch":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}}},"paths":{"/people/{id}":{"patch":{"operationId":"api_people_id_patch","tags":["Person"],"responses":{"200":{"description":"Person resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Person.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Partially update a person","description":"Updates specific fields of an existing person.","parameters":[{"name":"id","in":"path","description":"Person identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Person resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Person.jsonMergePatch"}}},"required":true}}}}}
```

## List person notes

> Returns all notes attached to a given person, ordered by flag and creation date.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"PersonNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"PersonNoteResource":{"type":"object","description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries.","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/people/{personId}/notes":{"get":{"operationId":"api_people_personIdnotes_get_collection","tags":["Person"],"responses":{"200":{"description":"PersonNoteResource collection","content":{"application/ld+json":{"schema":{"type":"object","description":"PersonNoteResource.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/PersonNoteResource.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonNoteResource"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"List person notes","description":"Returns all notes attached to a given person, ordered by flag and creation date.","parameters":[{"name":"personId","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"q","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"person","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"person[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"category.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"category.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"author.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"flagged","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"order[flagged]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}}}}
```

## Get person note

> Retrieves a single note attached to a person.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"PersonNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"PersonNoteResource":{"type":"object","description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries.","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/people/{personId}/notes/{id}":{"get":{"operationId":"api_people_personIdnotes_id_get","tags":["Person"],"responses":{"200":{"description":"PersonNoteResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Get person note","description":"Retrieves a single note attached to a person.","parameters":[{"name":"personId","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Create person note

> Creates a new note linked to a specific person.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"PersonNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"PersonNoteResource":{"type":"object","description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries.","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/people/{personId}/notes":{"post":{"operationId":"api_people_personIdnotes_post","tags":["Person"],"responses":{"201":{"description":"PersonNoteResource resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create person note","description":"Creates a new note linked to a specific person.","parameters":[{"name":"personId","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new PersonNoteResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}},"required":true}}}}}
```

## Replace person note

> Replaces all fields of a person note.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"PersonNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"PersonNoteResource":{"type":"object","description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries.","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/people/{personId}/notes/{id}":{"put":{"operationId":"api_people_personIdnotes_id_put","tags":["Person"],"responses":{"200":{"description":"PersonNoteResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replace person note","description":"Replaces all fields of a person note.","parameters":[{"name":"personId","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated PersonNoteResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}},"required":true}}}}}
```

## Update person note

> Updates one or more fields of a person note.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Person","description":"Represents a CRM contact person with details like name, email, phone, and tags."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"PersonNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"PersonNoteResource":{"type":"object","description":"Represents a CRM note attached to a person, such as contact moments or meeting summaries.","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"PersonNoteResource.jsonMergePatch":{"type":"object","properties":{"id":{"type":["string","null"]},"personId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}}}}},"paths":{"/people/{personId}/notes/{id}":{"patch":{"operationId":"api_people_personIdnotes_id_patch","tags":["Person"],"responses":{"200":{"description":"PersonNoteResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Update person note","description":"Updates one or more fields of a person note.","parameters":[{"name":"personId","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"PersonNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated PersonNoteResource resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PersonNoteResource.jsonMergePatch"}}},"required":true}}}}}
```


# Organizations

The organizations endpoint gives access to the **organizations** in the CRM.

Good to know:

* An organization must always contain a title

## Create an organization

> Creates a new organization with email, phone numbers, and metadata.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Organization.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}],"description":"Represents an organization in the CRM with name, contact details, tags, and related people."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/organizations":{"post":{"operationId":"api_organizations_post","tags":["Organization"],"responses":{"201":{"description":"Organization resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create an organization","description":"Creates a new organization with email, phone numbers, and metadata.","parameters":[],"requestBody":{"description":"The new Organization resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"required":true}}}}}
```

## List organization notes

> Retrieve all notes associated with a given organization.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"OrganizationNote.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a note related to an organization, such as comments or annotations."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"OrganizationNote":{"type":"object","description":"Represents a note related to an organization, such as comments or annotations.","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/organizations/{organizationId}/notes":{"get":{"operationId":"api_organizations_organizationIdnotes_get_collection","tags":["Organization"],"responses":{"200":{"description":"OrganizationNote collection","content":{"application/ld+json":{"schema":{"type":"object","description":"OrganizationNote.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationNote.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationNote"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"List organization notes","description":"Retrieve all notes associated with a given organization.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNote identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"q","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"organization","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"organization[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"category.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"category.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"author.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"flagged","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"order[flagged]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}}}}
```

## Get an organization

> Retrieves the details of a single organization by its ID.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Organization.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}],"description":"Represents an organization in the CRM with name, contact details, tags, and related people."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/organizations/{id}":{"get":{"operationId":"api_organizations_id_get","tags":["Organization"],"responses":{"200":{"description":"Organization resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Get an organization","description":"Retrieves the details of a single organization by its ID.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## List organizations

> Returns a filtered, paginated list of CRM organizations.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Organization.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}],"description":"Represents an organization in the CRM with name, contact details, tags, and related people."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/organizations":{"get":{"operationId":"api_organizations_get_collection","tags":["Organization"],"responses":{"200":{"description":"Organization collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Organization.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Organization.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"List organizations","description":"Returns a filtered, paginated list of CRM organizations.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"q","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"owner.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"owner.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"emailAddresses.email","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"emailAddresses.email[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"tags.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"tags.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"segments.uuid","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"segments.uuid[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"exists[archivedAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"order[title.sort]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[owner.lastName]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"identifiers","in":"query","description":"Filter by identifiers (searches LinkedIn IDs, email addresses, and phone numbers)","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"identifiers[]","in":"query","description":"Filter by multiple identifiers","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}}}}
```

## Delete organization note

> Removes or archives a note.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/organizations/{organizationId}/notes/{id}":{"delete":{"operationId":"api_organizations_organizationIdnotes_id_delete","tags":["Organization"],"responses":{"204":{"description":"OrganizationNoteResource resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Delete organization note","description":"Removes or archives a note.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Update organization note

> Updates selected fields of a note.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"OrganizationNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"OrganizationNoteResource":{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"OrganizationNoteResource.jsonMergePatch":{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}}}}},"paths":{"/organizations/{organizationId}/notes/{id}":{"patch":{"operationId":"api_organizations_organizationIdnotes_id_patch","tags":["Organization"],"responses":{"200":{"description":"OrganizationNoteResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Update organization note","description":"Updates selected fields of a note.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated OrganizationNoteResource resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource.jsonMergePatch"}}},"required":true}}}}}
```

## Replace organization note

> Fully replaces a note record by ID.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"OrganizationNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"OrganizationNoteResource":{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/organizations/{organizationId}/notes/{id}":{"put":{"operationId":"api_organizations_organizationIdnotes_id_put","tags":["Organization"],"responses":{"200":{"description":"OrganizationNoteResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replace organization note","description":"Fully replaces a note record by ID.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated OrganizationNoteResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource"}}},"required":true}}}}}
```

## Retrieve organization note

> Returns a single note belonging to an organization.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"OrganizationNoteResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"OrganizationNoteResource":{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/organizations/{organizationId}/notes/{id}":{"get":{"operationId":"api_organizations_organizationIdnotes_id_get","tags":["Organization"],"responses":{"200":{"description":"OrganizationNoteResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNoteResource"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieve organization note","description":"Returns a single note belonging to an organization.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"OrganizationNoteResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Replace an organization

> Replaces all updatable fields of the organization.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Organization.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}],"description":"Represents an organization in the CRM with name, contact details, tags, and related people."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/organizations/{id}":{"put":{"operationId":"api_organizations_id_put","tags":["Organization"],"responses":{"200":{"description":"Organization resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replace an organization","description":"Replaces all updatable fields of the organization.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Organization resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"required":true}}}}}
```

## Create a new organization note

> Adds a new note to the given organization.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"OrganizationNote.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]}],"description":"Represents a note related to an organization, such as comments or annotations."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"OrganizationNote":{"type":"object","description":"Represents a note related to an organization, such as comments or annotations.","properties":{"id":{"type":["string","null"]},"organizationId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"title":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"category":{"type":["string","null"],"format":"iri-reference"}},"required":["description","category"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/organizations/{organizationId}/notes":{"post":{"operationId":"api_organizations_organizationIdnotes_post","tags":["Organization"],"responses":{"201":{"description":"OrganizationNote resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNote.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNote"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create a new organization note","description":"Adds a new note to the given organization.","parameters":[{"name":"organizationId","in":"path","description":"OrganizationNote identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new OrganizationNote resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationNote"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNote"}}},"required":true}}}}}
```

## Partially update an organization

> Updates one or more fields of the organization.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Organization","description":"Represents an organization in the CRM with name, contact details, tags, and related people."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Organization.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload.jsonld_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload.jsonld_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload.jsonld"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}],"description":"Represents an organization in the CRM with name, contact details, tags, and related people."},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"EmailAddressPayload.jsonld_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload.jsonld_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload.jsonld":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Organization.jsonMergePatch":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}}}},"paths":{"/organizations/{id}":{"patch":{"operationId":"api_organizations_id_patch","tags":["Organization"],"responses":{"200":{"description":"Organization resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Partially update an organization","description":"Updates one or more fields of the organization.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Organization resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonMergePatch"}}},"required":true}}}}}
```


# Lists

The segments endpoint provides access to **lists** where you can organize and manage contacts.

## Creates a Segment resource.

> Creates a Segment resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"CRM","description":"Resource 'CRM' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Segment.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Segment":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/segments":{"post":{"operationId":"api_segments_post","tags":["CRM"],"responses":{"201":{"description":"Segment resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Segment resource.","description":"Creates a Segment resource.","parameters":[],"requestBody":{"description":"The new Segment resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"required":true}}}}}
```

## Retrieves a Segment resource.

> Retrieves a Segment resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"CRM","description":"Resource 'CRM' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Segment.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Segment":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/segments/{id}":{"get":{"operationId":"api_segments_id_get","tags":["CRM"],"responses":{"200":{"description":"Segment resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Segment resource.","description":"Retrieves a Segment resource.","parameters":[{"name":"id","in":"path","description":"Segment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Updates the Segment resource.

> Updates the Segment resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"CRM","description":"Resource 'CRM' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Segment.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Segment":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Segment.jsonMergePatch":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}}}}},"paths":{"/segments/{id}":{"patch":{"operationId":"api_segments_id_patch","tags":["CRM"],"responses":{"200":{"description":"Segment resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Segment resource.","description":"Updates the Segment resource.","parameters":[{"name":"id","in":"path","description":"Segment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Segment resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Segment.jsonMergePatch"}}},"required":true}}}}}
```

## Replaces the Segment resource.

> Replaces the Segment resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"CRM","description":"Resource 'CRM' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Segment.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Segment":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/segments/{id}":{"put":{"operationId":"api_segments_id_put","tags":["CRM"],"responses":{"200":{"description":"Segment resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replaces the Segment resource.","description":"Replaces the Segment resource.","parameters":[{"name":"id","in":"path","description":"Segment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Segment resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Segment"}},"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"required":true}}}}}
```

## Retrieves the collection of Segment resources.

> Retrieves the collection of Segment resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"CRM","description":"Resource 'CRM' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Segment.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Segment":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":["string","null"]},"icon":{"type":["string","null"]},"sequence":{"type":["integer","null"]}},"required":["title","icon"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/segments":{"get":{"operationId":"api_segments_get_collection","tags":["CRM"],"responses":{"200":{"description":"Segment collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Segment.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Segment.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Segment resources.","description":"Retrieves the collection of Segment resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false}]}}}}
```


# Workspaces

A workspace can contain tasks or deals.

## Retrieves a Workspace resource.

> Retrieves a Workspace resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Workspace","description":"Resource 'Workspace' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Workspace.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"privacy":{"enum":["private","public"],"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"owner":{"type":["string","null"],"format":"iri-reference"},"createdAt":{"type":["string","null"],"format":"date-time"},"estimation":{"type":["boolean","null"]},"estimationType":{"type":["string","null"]},"currency":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"workspaceType":{"type":["string","null"]},"users":{"type":"array","items":{"type":"string","format":"iri-reference"}},"emoji":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"totalAutomations":{"type":["integer","null"]},"columns":{"anyOf":[{"type":"array","items":{"type":"unknown_type"}},{"type":"array","items":{"type":"unknown_type"}}]},"columnOrder":{"writeOnly":true,"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]}},"required":["privacy","title","owner"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Workspace":{"type":"object","properties":{"id":{"type":["string","null"]},"privacy":{"enum":["private","public"],"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"owner":{"type":["string","null"],"format":"iri-reference"},"createdAt":{"type":["string","null"],"format":"date-time"},"estimation":{"type":["boolean","null"]},"estimationType":{"type":["string","null"]},"currency":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"workspaceType":{"type":["string","null"]},"users":{"type":"array","items":{"type":"string","format":"iri-reference"}},"emoji":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"totalAutomations":{"type":["integer","null"]},"columns":{"anyOf":[{"type":"array","items":{"type":"unknown_type"}},{"type":"array","items":{"type":"unknown_type"}}]},"columnOrder":{"writeOnly":true,"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]}},"required":["privacy","title","owner"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/workspaces/{id}":{"get":{"operationId":"api_workspaces_id_get","tags":["Workspace"],"responses":{"200":{"description":"Workspace resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Workspace.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Workspace resource.","description":"Retrieves a Workspace resource.","parameters":[{"name":"id","in":"path","description":"Workspace identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Retrieves the collection of Workspace resources.

> Retrieves the collection of Workspace resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Workspace","description":"Resource 'Workspace' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Workspace.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"privacy":{"enum":["private","public"],"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"owner":{"type":["string","null"],"format":"iri-reference"},"createdAt":{"type":["string","null"],"format":"date-time"},"estimation":{"type":["boolean","null"]},"estimationType":{"type":["string","null"]},"currency":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"workspaceType":{"type":["string","null"]},"users":{"type":"array","items":{"type":"string","format":"iri-reference"}},"emoji":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"totalAutomations":{"type":["integer","null"]},"columns":{"anyOf":[{"type":"array","items":{"type":"unknown_type"}},{"type":"array","items":{"type":"unknown_type"}}]},"columnOrder":{"writeOnly":true,"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]}},"required":["privacy","title","owner"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Workspace":{"type":"object","properties":{"id":{"type":["string","null"]},"privacy":{"enum":["private","public"],"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"owner":{"type":["string","null"],"format":"iri-reference"},"createdAt":{"type":["string","null"],"format":"date-time"},"estimation":{"type":["boolean","null"]},"estimationType":{"type":["string","null"]},"currency":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"workspaceType":{"type":["string","null"]},"users":{"type":"array","items":{"type":"string","format":"iri-reference"}},"emoji":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"isPrivate":{"type":["boolean","null"]},"totalAutomations":{"type":["integer","null"]},"columns":{"anyOf":[{"type":"array","items":{"type":"unknown_type"}},{"type":"array","items":{"type":"unknown_type"}}]},"columnOrder":{"writeOnly":true,"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]}},"required":["privacy","title","owner"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/workspaces":{"get":{"operationId":"api_workspaces_get_collection","tags":["Workspace"],"responses":{"200":{"description":"Workspace collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Workspace.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Workspace.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Workspace resources.","description":"Retrieves the collection of Workspace resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"title","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"title[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"description","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"description[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"owner","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"owner[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"exists[archivedAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false}]}}}}
```


# Tasks

Tasks are used on workspaces and can be connected to people, organizations, and conversations.

Good to know:

* A task must always contain a title
* A task must be part of a workspace
* The type (task or deal) is determined by the workspace

## Creates a Task resource.

> Creates a Task resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Task","description":"Resource 'Task' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Task.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject.jsonld"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"MediaObject.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}}]},"Task":{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}},"MediaObject":{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Task.CreateTaskPayload":{"type":"object","properties":{"parent":{"type":["string","null"],"format":"iri-reference"},"beforeTask":{"type":["string","null"],"format":"iri-reference"},"afterTask":{"type":["string","null"],"format":"iri-reference"},"positionTop":{"default":false,"type":["boolean","null"]},"participants":{"type":"array","items":{"type":"null"}},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/User.HeartbeatPayload"}},"observers":{"type":"array","items":{"$ref":"#/components/schemas/User.HeartbeatPayload"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"people":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"conversationItems":{"type":"array","items":{"$ref":"#/components/schemas/ConversationItem.ConversationItemChatPayload"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}},"required":["title"]},"User.HeartbeatPayload":{"type":"object"},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]},"Message":{"type":"object","properties":{"emailAccount":{"anyOf":[{"$ref":"#/components/schemas/EmailAccount"},{"type":"null"}]},"dateSent":{"type":["string","null"],"format":"date-time"},"subject":{"type":["string","null"]},"userSubject":{"type":["string","null"]},"snippet":{"type":["string","null"]},"attachments":{"type":"array","items":{"type":"null"}},"labels":{"type":"array","items":{"type":"null"}},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"hasAttachments":{"default":false,"type":"boolean"},"read":{"default":false,"type":"boolean"},"starred":{"default":false,"type":"boolean"},"sent":{"default":false,"type":"boolean"},"attachmentsInline":{"type":"array","items":{"type":"null"}},"provider":{"type":["string","null"]},"participants":{"type":"array","items":{"type":"null"}},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"from":{"type":"array","items":{"type":"null"}},"to":{"type":"array","items":{"type":"null"}},"cc":{"type":"array","items":{"type":"null"}},"bcc":{"type":"array","items":{"type":"null"}},"owner":{"default":false,"type":"boolean"},"hasAccess":{"default":false,"type":"boolean"},"write":{"default":false,"type":"boolean"},"conversationId":{"type":["string","null"]},"user":{"type":["string","null"],"format":"iri-reference"},"body":{"type":["string","null"]},"id":{"type":["string","null"]}}},"EmailAccount":{"type":"object","required":["label","emailAccountType","fromName","shareType"],"properties":{"label":{"type":["string","null"]},"emailAccountType":{"enum":["group","person"],"type":["string","null"]},"email":{"type":["string","null"]},"fromName":{"type":["string","null"]},"shareType":{"enum":["all","none","crm"],"type":["string","null"]},"color":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"authorized":{"type":["boolean","null"]},"integrationData":{"type":"array","items":{"type":"null"}},"owner":{"type":["string","null"],"format":"iri-reference"},"provider":{"anyOf":[{"$ref":"#/components/schemas/Integration"},{"type":"null"}]},"signaturesNew":{"type":"array","items":{"type":"string","format":"iri-reference"}},"signaturesReply":{"type":"array","items":{"type":"string","format":"iri-reference"}},"id":{"type":["string","null"]}}},"Integration":{"type":"object","properties":{"title":{"type":["string","null"]},"isDevelopment":{"default":false,"type":"boolean"},"category":{"type":["string","null"]},"description":{"type":["string","null"]},"privacyDescription":{"type":["string","null"]},"authUrl":{"type":["string","null"]},"redirectUrl":{"type":["string","null"]},"id":{"type":["string","null"]}}},"ConversationItem.ConversationItemChatPayload":{"type":"object","properties":{"replyTo":{"type":["string","null"],"format":"iri-reference"},"body":{"type":["string","null"]},"mentions":{"type":"array","items":{"$ref":"#/components/schemas/User.HeartbeatPayload"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject"}}},"required":["body"]}}},"paths":{"/tasks":{"post":{"operationId":"api_tasks_post","tags":["Task"],"responses":{"201":{"description":"Task resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Task.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Task resource.","description":"Creates a Task resource.","parameters":[],"requestBody":{"description":"The new Task resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Task.CreateTaskPayload"}},"application/json":{"schema":{"$ref":"#/components/schemas/Task.CreateTaskPayload"}}},"required":true}}}}}
```

## Creates a Task resource.

> Creates a Task resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Task","description":"Resource 'Task' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Task.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject.jsonld"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"MediaObject.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}}]},"Task":{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}},"MediaObject":{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Task.DuplicateTaskPayload":{"type":"object","description":"Duplicate task","properties":{"status":{"description":"Set status","type":["string","null"],"format":"iri-reference"},"title":{"type":["string","null"]},"isTemplate":{"default":false,"type":"boolean"},"people":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}},"Person":{"type":"object","description":"Represents a CRM contact person with details like name, email, phone, and tags.","required":["familyName"],"properties":{"familyName":{"type":["string","null"]},"givenName":{"type":["string","null"]},"additionalName":{"type":["string","null"]},"initials":{"type":["string","null"]},"customerId":{"type":["string","null"]},"honorificPrefix":{"type":["string","null"]},"isTracked":{"type":["boolean","null"]},"linkedinId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"owner":{"type":["string","null"],"format":"iri-reference"},"jobTitle":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"_organizations":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"null"}},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"address":{"$ref":"#/components/schemas/AddressPayload"},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"dealSize":{"type":["integer","null"]},"totalDeals":{"type":["integer","null"]},"totalLostDeals":{"type":["integer","null"]},"totalWonDeals":{"type":["integer","null"]},"linkedinEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}}},"EmailAddressPayload_noid":{"type":"object","required":["email"],"properties":{"email":{"format":"email","type":["string","null"]}}},"PhoneNumberPayload_noid":{"type":"object","required":["phoneNumber","phoneType"],"properties":{"phoneNumber":{"type":["string","null"]},"phoneType":{"enum":["fax","mobile","home","work"],"type":["string","null"]}}},"AddressPayload":{"type":"object","properties":{"city":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"street":{"type":["string","null"]},"country":{"default":"NL","type":["string","null"]}}},"Organization":{"type":"object","description":"Represents an organization in the CRM with name, contact details, tags, and related people.","properties":{"description":{"type":["string","null"]},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressPayload_noid"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberPayload_noid"}},"title":{"type":["string","null"]},"website":{"type":["string","null"]},"customerId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"chamberOfCommerceNumber":{"type":["string","null"]},"linkedinId":{"type":["string","null"]},"linkedinPublicIdentifier":{"readOnly":true,"type":["string","null"]},"linkedinInternalId":{"readOnly":true,"type":["string","null"]},"createdAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"importedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"updatedAt":{"readOnly":true,"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"address":{"$ref":"#/components/schemas/AddressPayload"},"owner":{"type":["string","null"],"format":"iri-reference"},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"avatarUrl":{"readOnly":true,"type":["string","null"]},"avatar":{"writeOnly":true,"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"segments":{"type":"array","items":{"type":"string","format":"iri-reference"}},"integrationParticipants":{"type":"array","items":{"type":"string","format":"iri-reference"}},"companyEnrichment":{"readOnly":true,"type":["boolean","null"]},"linkedinCompanyEnrichment":{"readOnly":true,"type":["array","null"],"items":{"type":"null"}},"id":{"type":["string","null"]}},"required":["title"]}}},"paths":{"/tasks/{id}/duplicate":{"post":{"operationId":"api_tasks_idduplicate_post","tags":["Task"],"responses":{"201":{"description":"Task resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Task.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Task resource.","description":"Creates a Task resource.","parameters":[{"name":"id","in":"path","description":"Task identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new Task resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Task.DuplicateTaskPayload"}},"application/json":{"schema":{"$ref":"#/components/schemas/Task.DuplicateTaskPayload"}}},"required":true}}}}}
```

## Creates a Task resource.

> Creates a Task resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Task","description":"Resource 'Task' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}}},"paths":{"/tasks/{id}/export":{"post":{"operationId":"api_tasks_idexport_post","tags":["Task"],"responses":{"204":{"description":"Task resource created","links":{}},"400":{"description":"Invalid input","links":{}},"403":{"description":"Forbidden","links":{}},"422":{"description":"An error occurred","links":{}}},"summary":"Creates a Task resource.","description":"Creates a Task resource.","parameters":[{"name":"id","in":"path","description":"Task identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Creates a TaskCommentResource resource.

> Creates a TaskCommentResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"TaskCommentResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskCommentResource":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/tasks/{taskId}/comments":{"post":{"operationId":"api_tasks_taskIdcomments_post","tags":["Tasks"],"responses":{"201":{"description":"TaskCommentResource resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a TaskCommentResource resource.","description":"Creates a TaskCommentResource resource.","parameters":[{"name":"taskId","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new TaskCommentResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}},"required":true}}}}}
```

## Retrieves a Task resource.

> Retrieves a Task resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Task","description":"Resource 'Task' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Task.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject.jsonld"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"MediaObject.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}}]},"Task":{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}},"MediaObject":{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks/{id}":{"get":{"operationId":"api_tasks_id_get","tags":["Task"],"responses":{"200":{"description":"Task resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Task.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Task resource.","description":"Retrieves a Task resource.","parameters":[{"name":"id","in":"path","description":"Task identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Retrieves a TaskCommentResource resource.

> Retrieves a TaskCommentResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"TaskCommentResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskCommentResource":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks/{taskId}/comments/{id}":{"get":{"operationId":"api_tasks_taskIdcomments_id_get","tags":["Tasks"],"responses":{"200":{"description":"TaskCommentResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TaskCommentResource resource.","description":"Retrieves a TaskCommentResource resource.","parameters":[{"name":"taskId","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Updates the TaskCommentResource resource.

> Updates the TaskCommentResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"TaskCommentResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskCommentResource":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"TaskCommentResource.jsonMergePatch":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}}}}},"paths":{"/tasks/{taskId}/comments/{id}":{"patch":{"operationId":"api_tasks_taskIdcomments_id_patch","tags":["Tasks"],"responses":{"200":{"description":"TaskCommentResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the TaskCommentResource resource.","description":"Updates the TaskCommentResource resource.","parameters":[{"name":"taskId","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TaskCommentResource resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource.jsonMergePatch"}}},"required":true}}}}}
```

## Retrieves a TaskHistory resource.

> Retrieves a TaskHistory resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"TaskHistory.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"changes":{"type":"array","items":{"type":"null"}},"author":{"type":"string","format":"iri-reference"}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskHistory":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"changes":{"type":"array","items":{"type":"null"}},"author":{"type":"string","format":"iri-reference"}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks/{taskId}/history/{id}":{"get":{"operationId":"api_tasks_taskIdhistory_id_get","tags":["Tasks"],"responses":{"200":{"description":"TaskHistory resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskHistory.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskHistory"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TaskHistory resource.","description":"Retrieves a TaskHistory resource.","parameters":[{"name":"taskId","in":"path","description":"TaskHistory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"TaskHistory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Replaces the TaskCommentResource resource.

> Replaces the TaskCommentResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"TaskCommentResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskCommentResource":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/tasks/{taskId}/comments/{id}":{"put":{"operationId":"api_tasks_taskIdcomments_id_put","tags":["Tasks"],"responses":{"200":{"description":"TaskCommentResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replaces the TaskCommentResource resource.","description":"Replaces the TaskCommentResource resource.","parameters":[{"name":"taskId","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TaskCommentResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/TaskCommentResource"}}},"required":true}}}}}
```

## Updates the UpdateTaskResource resource.

> Updates the UpdateTaskResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"UpdateTaskResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"completedAt":{"description":"Task is completed at","type":["string","null"],"format":"date-time"},"files":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"anyOf":[{"$ref":"#/components/schemas/TaskRecurringSettingsInput.jsonld"},{"type":"null"}]},"id":{"type":["string","null"]},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"description":"Assignees belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"description":"Obersers belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"tags":{"description":"Tags of this task","type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"description":"People belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"description":"Organizations belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"messages":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"conversationItems":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskRecurringSettingsInput.jsonld":{"type":"object","properties":{"rrule":{"type":["string","null"]},"recurUntilCount":{"default":0,"type":"integer"},"recurUntil":{"type":["string","null"],"format":"date-time"},"recurOnSchedule":{"default":false,"type":"boolean"},"createNewTask":{"default":false,"type":"boolean"},"snooze":{"default":false,"type":"boolean"},"recurData":{"type":"array","items":{"type":"null"}}}},"UpdateTaskResource":{"type":"object","properties":{"completedAt":{"description":"Task is completed at","type":["string","null"],"format":"date-time"},"files":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"anyOf":[{"$ref":"#/components/schemas/TaskRecurringSettingsInput"},{"type":"null"}]},"id":{"type":["string","null"]},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"description":"Assignees belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"description":"Obersers belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"tags":{"description":"Tags of this task","type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"description":"People belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"description":"Organizations belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"messages":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"conversationItems":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}},"required":["title"]},"TaskRecurringSettingsInput":{"type":"object","properties":{"rrule":{"type":["string","null"]},"recurUntilCount":{"default":0,"type":"integer"},"recurUntil":{"type":["string","null"],"format":"date-time"},"recurOnSchedule":{"default":false,"type":"boolean"},"createNewTask":{"default":false,"type":"boolean"},"snooze":{"default":false,"type":"boolean"},"recurData":{"type":"array","items":{"type":"null"}}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"UpdateTaskResource.jsonMergePatch":{"type":"object","properties":{"completedAt":{"description":"Task is completed at","type":["string","null"],"format":"date-time"},"files":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"anyOf":[{"$ref":"#/components/schemas/TaskRecurringSettingsInput"},{"type":"null"}]},"id":{"type":["string","null"]},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"description":"Assignees belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"description":"Obersers belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"tags":{"description":"Tags of this task","type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"description":"People belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"description":"Organizations belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"messages":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"conversationItems":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}}}}},"paths":{"/tasks/{id}":{"patch":{"operationId":"api_tasks_id_patch","tags":["Tasks"],"responses":{"200":{"description":"UpdateTaskResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the UpdateTaskResource resource.","description":"Updates the UpdateTaskResource resource.","parameters":[{"name":"id","in":"path","description":"UpdateTaskResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated UpdateTaskResource resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource.jsonMergePatch"}}},"required":true}}}}}
```

## Replaces the UpdateTaskResource resource.

> Replaces the UpdateTaskResource resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"UpdateTaskResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"completedAt":{"description":"Task is completed at","type":["string","null"],"format":"date-time"},"files":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"anyOf":[{"$ref":"#/components/schemas/TaskRecurringSettingsInput.jsonld"},{"type":"null"}]},"id":{"type":["string","null"]},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"description":"Assignees belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"description":"Obersers belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"tags":{"description":"Tags of this task","type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"description":"People belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"description":"Organizations belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"messages":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"conversationItems":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskRecurringSettingsInput.jsonld":{"type":"object","properties":{"rrule":{"type":["string","null"]},"recurUntilCount":{"default":0,"type":"integer"},"recurUntil":{"type":["string","null"],"format":"date-time"},"recurOnSchedule":{"default":false,"type":"boolean"},"createNewTask":{"default":false,"type":"boolean"},"snooze":{"default":false,"type":"boolean"},"recurData":{"type":"array","items":{"type":"null"}}}},"UpdateTaskResource":{"type":"object","properties":{"completedAt":{"description":"Task is completed at","type":["string","null"],"format":"date-time"},"files":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"anyOf":[{"$ref":"#/components/schemas/TaskRecurringSettingsInput"},{"type":"null"}]},"id":{"type":["string","null"]},"title":{"description":"Title of task","type":["string","null"]},"description":{"description":"Short description of task","type":["string","null"]},"status":{"description":"Workspace","type":["string","null"],"format":"iri-reference"},"author":{"description":"Author of this task","type":["string","null"],"format":"iri-reference"},"assignees":{"description":"Assignees belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"description":"Obersers belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"tags":{"description":"Tags of this task","type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"description":"People belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"description":"Organizations belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"messages":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"conversationItems":{"description":"Messages belonging to this task","type":"array","items":{"type":"string","format":"iri-reference"}},"isFlagged":{"description":"Highlight this task","default":false,"type":"boolean"},"archivedAt":{"description":"Archive task","type":["string","null"],"format":"date-time"},"dueDate":{"description":"Date when this task is due","type":["string","null"],"format":"date-time"},"isTemplate":{"description":"Task is a template","default":false,"type":"boolean"},"storyPointEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"timeEstimation":{"maximum":4294967295,"type":["integer","null"]},"scheduledOn":{"description":"Date when task is scheduled","type":["string","null"],"format":"date-time"},"plannedWeek":{"description":"Date when task is planned in week","type":["string","null"],"format":"date-time"},"plannedMonth":{"description":"Date when task is planned in month","type":["string","null"],"format":"date-time"},"snoozeUntil":{"description":"Snooze task until","type":["string","null"],"format":"date-time"}},"required":["title"]},"TaskRecurringSettingsInput":{"type":"object","properties":{"rrule":{"type":["string","null"]},"recurUntilCount":{"default":0,"type":"integer"},"recurUntil":{"type":["string","null"],"format":"date-time"},"recurOnSchedule":{"default":false,"type":"boolean"},"createNewTask":{"default":false,"type":"boolean"},"snooze":{"default":false,"type":"boolean"},"recurData":{"type":"array","items":{"type":"null"}}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/tasks/{id}":{"put":{"operationId":"api_tasks_id_put","tags":["Tasks"],"responses":{"200":{"description":"UpdateTaskResource resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replaces the UpdateTaskResource resource.","description":"Replaces the UpdateTaskResource resource.","parameters":[{"name":"id","in":"path","description":"UpdateTaskResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated UpdateTaskResource resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResource"}}},"required":true}}}}}
```

## Retrieves the collection of Task resources.

> Retrieves the collection of Task resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Task","description":"Resource 'Task' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Task.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject.jsonld"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"MediaObject.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}}]},"Task":{"type":"object","properties":{"id":{"type":["string","null"]},"position":{"type":["integer","null"]},"totalComments":{"type":["integer","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"isFlagged":{"type":["boolean","null"]},"isSubTask":{"type":["boolean","null"]},"indexNumber":{"type":["integer","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"dueDate":{"type":["string","null"],"format":"date-time"},"workspace":{"type":["string","null"],"format":"iri-reference"},"status":{"type":["string","null"],"format":"iri-reference"},"author":{"type":["string","null"],"format":"iri-reference"},"parent":{"type":["string","null"],"format":"iri-reference"},"tags":{"type":"array","items":{"type":"string","format":"iri-reference"}},"assignees":{"type":"array","items":{"type":"string","format":"iri-reference"}},"observers":{"type":"array","items":{"type":"string","format":"iri-reference"}},"subTasks":{"anyOf":[{"type":"array","items":{"type":"string","format":"iri-reference"}},{"type":"array","items":{"type":"string","format":"iri-reference"}}]},"completedSubtasks":{"type":["integer","null"]},"totalSubtasks":{"type":["integer","null"]},"isTemplate":{"type":["boolean","null"]},"storyPointEstimation":{"type":["integer","null"]},"timeEstimation":{"type":["integer","null"]},"dealSizeEstimation":{"type":["integer","null"]},"messageProvider":{"type":["string","null"]},"scheduledOn":{"type":["string","null"]},"previouslyScheduledOn":{"type":["string","null"]},"plannedWeek":{"type":["string","null"]},"plannedMonth":{"type":["string","null"]},"snoozeUntil":{"type":["string","null"],"format":"date-time"},"isRecurring":{"type":["boolean","null"]},"workspaceType":{"type":["string","null"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/MediaObject"}},"messages":{"type":"array","items":{"type":"null"}},"conversationItems":{"type":"array","items":{"type":"string","format":"iri-reference"}},"people":{"type":"array","items":{"type":"string","format":"iri-reference"}},"organizations":{"type":"array","items":{"type":"string","format":"iri-reference"}},"recurringSettings":{"type":"array","items":{"type":"null"}},"automation":{"type":["string","null"],"format":"iri-reference"},"startDate":{"type":["string","null"],"format":"date-time"},"blockedFields":{"type":"array","items":{"type":"null"}}}},"MediaObject":{"type":"object","required":["file"],"properties":{"file":{"writeOnly":true,"type":["string","null"],"format":"binary"},"id":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"size":{"type":["integer","null"]},"mimeType":{"type":["string","null"]},"contentId":{"type":["string","null"]},"updatedAt":{"type":["string","null"],"format":"date-time"},"publicUrl":{"type":["string","null"]}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks":{"get":{"operationId":"api_tasks_get_collection","tags":["Task"],"responses":{"200":{"description":"Task collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Task.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Task.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Task resources.","description":"Retrieves the collection of Task resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"author.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"assignees.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"assignees.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"observers.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"observers.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"workspace.uuid","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"workspace.uuid[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"status.uuid","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"status.uuid[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"message.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"message.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"tags.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"tags.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"people.personId","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"people.personId[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"organizations.organizationId","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"organizations.organizationId[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"order[position]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[dueDate]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[storyPointEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[timeEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[dealSizeEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[scheduledOn]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"completedAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"completedAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"completedAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"completedAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"archivedAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"dueDate[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"dueDate[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"dueDate[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"dueDate[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"scheduledOn[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"scheduledOn[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"scheduledOn[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"scheduledOn[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"snoozeUntil[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"snoozeUntil[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"snoozeUntil[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"snoozeUntil[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"startDate[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"startDate[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"startDate[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"startDate[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"exists[completedAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[archivedAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[snoozeUntil]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[assignees.id]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[workspace.uuid]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[message.id]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[tags.id]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[people.personId]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[organizations.organizationId]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[storyPointEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[dealSizeEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[timeEstimation]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"view","in":"query","description":"Filter parameter to specify the view. To get only UUIDs, use 'idx'.","required":false,"deprecated":false,"schema":{"type":"string","enum":["idx"]},"style":"form","explode":false}]}}}}
```

## Retrieves the collection of TaskCommentResource resources.

> Retrieves the collection of TaskCommentResource resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"TaskCommentResource.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskCommentResource":{"type":"object","properties":{"id":{"type":["string","null"]},"taskId":{"writeOnly":true,"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"description":{"type":["string","null"]},"flagged":{"type":["boolean","null"]},"author":{"type":["string","null"],"format":"iri-reference"},"mentions":{"type":"array","items":{"type":"string","format":"iri-reference"}}},"required":["description"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks/{taskId}/comments":{"get":{"operationId":"api_tasks_taskIdcomments_get_collection","tags":["Tasks"],"responses":{"200":{"description":"TaskCommentResource collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TaskCommentResource.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TaskCommentResource.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskCommentResource"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TaskCommentResource resources.","description":"Retrieves the collection of TaskCommentResource resources.","parameters":[{"name":"taskId","in":"path","description":"TaskCommentResource identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"createdAt[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"createdAt[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"flagged","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"author.id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author.id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"order[flagged]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]},"style":"form","explode":false}]}}}}
```

## Retrieves the collection of TaskHistory resources.

> Retrieves the collection of TaskHistory resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tasks","description":"Resource 'Tasks' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"TaskHistory.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"changes":{"type":"array","items":{"type":"null"}},"author":{"type":"string","format":"iri-reference"}}}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"TaskHistory":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"changes":{"type":"array","items":{"type":"null"}},"author":{"type":"string","format":"iri-reference"}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tasks/{taskId}/history":{"get":{"operationId":"api_tasks_taskIdhistory_get_collection","tags":["Tasks"],"responses":{"200":{"description":"TaskHistory collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TaskHistory.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TaskHistory.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskHistory"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TaskHistory resources.","description":"Retrieves the collection of TaskHistory resources.","parameters":[{"name":"taskId","in":"path","description":"TaskHistory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"order[createdAt]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false}]}}}}
```


# Tags

## Creates a Tag resource.

> Creates a Tag resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tag","description":"Resource 'Tag' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Tag.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Tag.CreateTagPayload":{"type":"object","required":["title"],"properties":{"title":{"type":["string","null"]},"backgroundColor":{"description":"Background color of label","type":["string","null"]},"textColor":{"description":"Text color of label","type":["string","null"]},"description":{"description":"Description of tag","type":["string","null"]}}}}},"paths":{"/tags":{"post":{"operationId":"api_tags_post","tags":["Tag"],"responses":{"201":{"description":"Tag resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Tag resource.","description":"Creates a Tag resource.","parameters":[],"requestBody":{"description":"The new Tag resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag.CreateTagPayload"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag.CreateTagPayload"}}},"required":true}}}}}
```

## Retrieves a Tag resource.

> Retrieves a Tag resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tag","description":"Resource 'Tag' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Tag.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tags/{id}":{"get":{"operationId":"api_tags_id_get","tags":["Tag"],"responses":{"200":{"description":"Tag resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Tag resource.","description":"Retrieves a Tag resource.","parameters":[{"name":"id","in":"path","description":"Tag identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}}}
```

## Updates the Tag resource.

> Updates the Tag resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tag","description":"Resource 'Tag' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Tag.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Tag.jsonMergePatch":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}}},"paths":{"/tags/{id}":{"patch":{"operationId":"api_tags_id_patch","tags":["Tag"],"responses":{"200":{"description":"Tag resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Tag resource.","description":"Updates the Tag resource.","parameters":[{"name":"id","in":"path","description":"Tag identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Tag resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Tag.jsonMergePatch"}}},"required":true}}}}}
```

## Replaces the Tag resource.

> Replaces the Tag resource.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tag","description":"Resource 'Tag' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"Tag.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}},"paths":{"/tags/{id}":{"put":{"operationId":"api_tags_id_put","tags":["Tag"],"responses":{"200":{"description":"Tag resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Replaces the Tag resource.","description":"Replaces the Tag resource.","parameters":[{"name":"id","in":"path","description":"Tag identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Tag resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Tag"}},"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"required":true}}}}}
```

## Retrieves the collection of Tag resources.

> Retrieves the collection of Tag resources.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"Tag","description":"Resource 'Tag' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"HydraCollectionBaseSchema":{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"type":"object"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"Tag.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]}]},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Tag":{"type":"object","properties":{"id":{"type":["string","null"]},"backgroundColor":{"type":["string","null"]},"textColor":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["title"]},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":"number","default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}},"paths":{"/tags":{"get":{"operationId":"api_tags_get_collection","tags":["Tag"],"responses":{"200":{"description":"Tag collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Tag.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Tag.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Tag resources.","description":"Retrieves the collection of Tag resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":15,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]}}}}
```


# What is a webhook?

All about webhooks

A webhook is a lightweight, event-driven communication that automatically sends data between applications via HTTP. Triggered by specific events, webhooks automate communication between application programming interfaces (APIs) and can be used to activate workflows.

Because webhooks can connect event sources to automation solutions, they are 1 way to launch event-driven automation to perform IT actions when a specified event occurs.

#### How are webhooks different from an API?

Think of an API like ordering food by calling the restaurant every few minutes to ask, “Is my order ready yet?” You keep dialing until you get a “Yes!” answer.

A webhook, by contrast, is like giving the restaurant your phone number and asking them to call you the moment your food is done. You set it up once—hand over a special phone number (URL) and say “Call me when X happens”—and then you hang up. No more checking in. When that event occurs, the restaurant (server) simply rings you (sends a POST) with all the details.

\
**Key differences**

* Who does the work
  * **API polling:** You (the client) keep asking for updates.
  * **Webhook push:** The restaurant (server) calls you only when there’s news.
* Traffic and timing
  * **Polling:** Can waste time and bandwidth checking in when nothing’s changed.
  * **Webhook:** Instant, only one message when it matters.
* Relationship to each other
  * A webhook isn’t a replacement for an API—it needs an API behind it to define what “events” are possible and what data will be sent.

> In short, APIs allow you to request information at any time; webhooks enable the server to notify you precisely when an event occurs.


# Set up a webhook

You need to have at least admin rights to create webhooks. You can only configure webhooks for channels you have access to.

* Go to <https://app.rogerroger.io/admin>
* Click 'Webhooks'
* Click 'Create webhook'
* Add a valid URL (must be https), a description, actions, and the channels you want to receive these events from.

Make sure you only use the events you need and select the channels you need the events from. This is to prevent overload on the receiving end.

#### Handling webhooks

RogerRoger expects a 2XX response if the webhook was received.

Make sure to send the 2XX response ASAP. Add your own queue handling if needed.

When a webhook fails, the system will automatically retry. After 15 failed retries, the webhook will be disabled. You can enable the webhook in the RogerRoger admin panel.

{% hint style="success" %}
Want to test your webhook? <https://webhook-test.com/>
{% endhint %}


# Conversation

With the conversation webhook, you can listen to conversation events.

Topics available:

* message.sent
* message.received

Example data:

```
{
  "id": "db043c7d-5e9f-4cdc-975a-eeedcfa9069e",
  "event": "message.sent",
  "data": {
    "author_id": "29c33283-af94-475e-a228-95d335f7d237",
    "account_id": "dd1df056-5554-47de-a3bc-ae5b08cfdbcd",
    "inline_attachments": [],
    "body": "Hello World!
\n",
    "from": [
      {
        "name": "John Doe",
        "profile_picture": "someserver/john_doe.png"
      }
    ],
    "snippet": "Hello world!\n",
    "conversation_id": "db043c7d-5e9f-4cdc-975a-eeedcfa9069e",
    "id": "9eb7b5a5-cad9-48a5-8f87-508cfabda544",
    "modified_at": 1751365754,
    "date": 1751365754,
    "type": "linkedin",
    "metadata": [],
    "attachments": [],
    "is_sent": true,
    "is_hidden": false,
    "is_event": false,
    "event_type": null
  },
  "idempotency_key": "6db043c7d665e9f1234cdc90975a7eeedcfa9069e
"
}
```


# Whatsapp messages

## Send WhatsApp message

> Send a WhatsApp message to any phone number using your connected WhatsApp account.\
> \
> \*\*Rate Limits (per account):\*\*\
> \- Burst: 6 messages capacity (refills 1 token every 20 seconds = 3/min)\
> \- Hourly: 60 messages per hour (sliding window)\
> \
> \*\*Response Headers:\*\*\
> \- \`X-RateLimit-Burst-Limit\`: Maximum burst capacity\
> \- \`X-RateLimit-Burst-Remaining\`: Remaining burst tokens\
> \- \`X-RateLimit-Hour-Limit\`: Maximum messages per hour\
> \- \`X-RateLimit-Hour-Remaining\`: Remaining hourly quota\
> \- \`Retry-After\`: Seconds to wait if rate limited (429 response)\
> \
> \*\*Processing:\*\*\
> Messages are processed asynchronously. The endpoint returns 201 immediately and processing happens in the background.

```json
{"openapi":"3.1.0","info":{"title":"RogerRoger API","version":"1.0.0"},"tags":[{"name":"WhatsAppMessage","description":"Resource 'WhatsAppMessage' operations."}],"servers":[{"url":"https://api.rogerroger.io","description":"API"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, available from the dashboard","name":"X-API-KEY","in":"header"}},"schemas":{"WhatsAppMessage":{"type":"object","required":["accountId","phoneNumber","message"],"properties":{"accountId":{"format":"uuid","description":"Your WhatsApp account ID from RogerRoger","type":["string","null"]},"phoneNumber":{"pattern":"^(\\+?[1-9]\\d{1,14})$","description":"Recipient phone number in E.164 format (with country code)","type":["string","null"]},"message":{"minLength":1,"maxLength":4096,"description":"Message text to send (1-4096 characters)","type":["string","null"]},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Public URL to the file to attach"}},"required":["url"]}}}}}},"paths":{"/whatsapp/messages":{"post":{"operationId":"api_whatsappmessages_post","tags":["WhatsAppMessage"],"responses":{"201":{"description":"Message queued successfully. Check rate limit headers for remaining quota.","headers":{"X-RateLimit-Burst-Limit":{"description":"Maximum burst capacity (6)","schema":{"type":"integer"}},"X-RateLimit-Burst-Remaining":{"description":"Remaining burst tokens","schema":{"type":"integer"}},"X-RateLimit-Hour-Limit":{"description":"Maximum messages per hour (60)","schema":{"type":"integer"}},"X-RateLimit-Hour-Remaining":{"description":"Remaining hourly quota","schema":{"type":"integer"}}},"links":{}},"400":{"description":"Validation error (invalid UUID, phone format, or message length)","links":{}},"401":{"description":"Unauthorized (invalid JWT token or API key)"},"403":{"description":"Forbidden","links":{}},"404":{"description":"WhatsApp account not found or access denied"},"422":{"description":"An error occurred","links":{}},"429":{"description":"Rate limit exceeded. Check Retry-After header for wait time in seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}},"X-RateLimit-Burst-Remaining":{"description":"Remaining burst tokens (0 if burst limit hit)","schema":{"type":"integer"}},"X-RateLimit-Hour-Remaining":{"description":"Remaining hourly quota (0 if hourly limit hit)","schema":{"type":"integer"}}}}},"summary":"Send WhatsApp message","description":"Send a WhatsApp message to any phone number using your connected WhatsApp account.\n\n**Rate Limits (per account):**\n- Burst: 6 messages capacity (refills 1 token every 20 seconds = 3/min)\n- Hourly: 60 messages per hour (sliding window)\n\n**Response Headers:**\n- `X-RateLimit-Burst-Limit`: Maximum burst capacity\n- `X-RateLimit-Burst-Remaining`: Remaining burst tokens\n- `X-RateLimit-Hour-Limit`: Maximum messages per hour\n- `X-RateLimit-Hour-Remaining`: Remaining hourly quota\n- `Retry-After`: Seconds to wait if rate limited (429 response)\n\n**Processing:**\nMessages are processed asynchronously. The endpoint returns 201 immediately and processing happens in the background.","parameters":[],"requestBody":{"description":"The new WhatsAppMessage resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessage"}}},"required":true}}}}}
```