People
The people endpoint gives access to the people in the CRM.
Good to know:
A person must always contain a familyname
Creates a person with emails, phone numbers, and metadata.
Represents a CRM contact person with details like name, email, phone, and tags.
/users/{id}["/tags/{id}"]["/segments/{id}"]["/organizations/{id}"]/media_objects/{id}Person resource created
Invalid input
Forbidden
An error occurred
POST /people HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 599
{
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatar": "/media_objects/{id}",
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"id": null
}{
"@context": "text",
"@id": "text",
"@type": "text",
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"createdAt": null,
"updatedAt": null,
"importedAt": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatarUrl": null,
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"linkedinEnrichment": [
null
],
"id": null
}Retrieve a paginated list of people.
The collection page number
1The number of items per page
15Filter by identifiers (searches LinkedIn IDs, email addresses, and phone numbers)
Filter by multiple identifiers
Filter parameter to specify the view. To get only UUIDs, use 'idx'.
Person collection
Person.jsonld collection.
Forbidden
GET /people HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"member": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"createdAt": null,
"updatedAt": null,
"importedAt": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatarUrl": null,
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"linkedinEnrichment": [
null
],
"id": null
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}Get a single person by ID.
Person identifier
Person resource
Represents a CRM contact person with details like name, email, phone, and tags.
Forbidden
Not found
GET /people/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"createdAt": null,
"updatedAt": null,
"importedAt": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatarUrl": null,
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"linkedinEnrichment": [
null
],
"id": null
}Replaces all fields of a person.
Person identifier
Represents a CRM contact person with details like name, email, phone, and tags.
/users/{id}["/tags/{id}"]["/segments/{id}"]["/organizations/{id}"]/media_objects/{id}Person resource updated
Represents a CRM contact person with details like name, email, phone, and tags.
Invalid input
Forbidden
Not found
An error occurred
PUT /people/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 599
{
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatar": "/media_objects/{id}",
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"id": null
}{
"@context": "text",
"@id": "text",
"@type": "text",
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"createdAt": null,
"updatedAt": null,
"importedAt": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatarUrl": null,
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"linkedinEnrichment": [
null
],
"id": null
}Updates specific fields of an existing person.
Person identifier
Represents a CRM contact person with details like name, email, phone, and tags.
/users/{id}["/tags/{id}"]["/segments/{id}"]["/organizations/{id}"]/media_objects/{id}Person resource updated
Represents a CRM contact person with details like name, email, phone, and tags.
Invalid input
Forbidden
Not found
An error occurred
PATCH /people/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 599
{
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatar": "/media_objects/{id}",
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"id": null
}{
"@context": "text",
"@id": "text",
"@type": "text",
"familyName": null,
"givenName": null,
"additionalName": null,
"initials": null,
"customerId": null,
"honorificPrefix": null,
"isTracked": null,
"linkedinId": null,
"externalSource": null,
"createdAt": null,
"updatedAt": null,
"importedAt": null,
"archivedAt": null,
"owner": "/users/{id}",
"jobTitle": null,
"tags": [
"/tags/{id}"
],
"segments": [
"/segments/{id}"
],
"organizations": [
"/organizations/{id}"
],
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"address": {
"city": null,
"postalCode": null,
"street": null,
"country": "NL"
},
"avatarUrl": null,
"dealSize": null,
"totalDeals": null,
"totalLostDeals": null,
"totalWonDeals": null,
"linkedinEnrichment": [
null
],
"id": null
}Returns all notes attached to a given person, ordered by flag and creation date.
PersonNoteResource identifier
The collection page number
1The number of items per page
15PersonNoteResource collection
PersonNoteResource.jsonld collection.
Forbidden
GET /people/{personId}/notes HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"member": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}Retrieves a single note attached to a person.
PersonNoteResource identifier
PersonNoteResource identifier
PersonNoteResource resource
Represents a CRM note attached to a person, such as contact moments or meeting summaries.
Forbidden
Not found
GET /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}Creates a new note linked to a specific person.
PersonNoteResource identifier
Represents a CRM note attached to a person, such as contact moments or meeting summaries.
/users/{id}/note_categories/{id}PersonNoteResource resource created
Invalid input
Forbidden
An error occurred
POST /people/{personId}/notes HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 166
{
"id": null,
"personId": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}Replaces all fields of a person note.
PersonNoteResource identifier
PersonNoteResource identifier
Represents a CRM note attached to a person, such as contact moments or meeting summaries.
/users/{id}/note_categories/{id}PersonNoteResource resource updated
Represents a CRM note attached to a person, such as contact moments or meeting summaries.
Invalid input
Forbidden
Not found
An error occurred
PUT /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 166
{
"id": null,
"personId": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}Updates one or more fields of a person note.
PersonNoteResource identifier
PersonNoteResource identifier
/users/{id}/note_categories/{id}PersonNoteResource resource updated
Represents a CRM note attached to a person, such as contact moments or meeting summaries.
Invalid input
Forbidden
Not found
An error occurred
PATCH /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 166
{
"id": null,
"personId": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"title": null,
"flagged": null,
"isPrivate": null,
"author": "/users/{id}",
"category": "/note_categories/{id}"
}Last updated

