# 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}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.rogerroger.io/crm/people.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.