Go to app

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

post

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

Authorizations
Body

Represents a CRM contact person with details like name, email, phone, and tags.

@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
familyNamestring | nullRequired
givenNamestring | nullOptional
additionalNamestring | nullOptional
initialsstring | nullOptional
customerIdstring | nullOptional
honorificPrefixstring | nullOptional
isTrackedboolean | nullOptional
linkedinIdstring | nullOptional
externalSourcestring | nullOptional
createdAtstring | nullRead-onlyOptional
updatedAtstring | nullRead-onlyOptional
importedAtstring | nullRead-onlyOptional
archivedAtstring | nullOptional
ownerstring | nullOptionalExample: /users/{id}
jobTitlestring | nullOptional
tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]
segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]
organizationsstring · iri-reference[]OptionalExample: ["/organizations/{id}"]
_organizationsstring[]Read-onlyOptionalDeprecated
avatarUrlstring | nullRead-onlyOptional
avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}
integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/
idstring | nullOptional
Responses
201
Person resource created
post
POST /people HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 573

{
  "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}",
  "integrationParticipants": [
    "https://example.com/"
  ],
  "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": [
    {
      "@context": "text",
      "@type": "text",
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "@context": "text",
      "@type": "text",
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "avatarUrl": null,
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

List people

get

Retrieve a paginated list of people.

Authorizations
Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
qstringOptional
owner.idstringOptional
owner.id[]string[]Optional
emailAddresses.emailstringOptional
emailAddresses.email[]string[]Optional
tags.idstringOptional
tags.id[]string[]Optional
segments.uuidstringOptional
segments.uuid[]string[]Optional
exists[archivedAt]booleanOptional
order[familyName]string · enumOptionalPossible values:
order[createdAt]string · enumOptionalPossible values:
createdAt[strictly_after]stringOptional
createdAt[after]stringOptional
createdAt[strictly_before]stringOptional
createdAt[before]stringOptional
viewstring · enumOptional

Filter parameter to specify the view. To get only UUIDs, use 'idx'.

Possible values:
Responses
200
Person collection
get
GET /people HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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": [
        {
          "@context": "text",
          "@type": "text",
          "email": null
        }
      ],
      "phoneNumbers": [
        {
          "@context": "text",
          "@type": "text",
          "phoneNumber": null,
          "phoneType": "fax"
        }
      ],
      "address": {
        "@context": "text",
        "@id": "text",
        "@type": "text",
        "city": null,
        "postalCode": null,
        "street": null,
        "country": "NL"
      },
      "avatarUrl": null,
      "integrationParticipants": [
        "https://example.com/"
      ],
      "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
      }
    ]
  }
}

Retrieve a person

get

Get a single person by ID.

Authorizations
Path parameters
idstringRequired

Person identifier

Responses
200
Person resource
get
GET /people/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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": [
    {
      "@context": "text",
      "@type": "text",
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "@context": "text",
      "@type": "text",
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "avatarUrl": null,
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

Update a person

put

Replaces all fields of a person.

Authorizations
Path parameters
idstringRequired

Person identifier

Body

Represents a CRM contact person with details like name, email, phone, and tags.

@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
familyNamestring | nullRequired
givenNamestring | nullOptional
additionalNamestring | nullOptional
initialsstring | nullOptional
customerIdstring | nullOptional
honorificPrefixstring | nullOptional
isTrackedboolean | nullOptional
linkedinIdstring | nullOptional
externalSourcestring | nullOptional
createdAtstring | nullRead-onlyOptional
updatedAtstring | nullRead-onlyOptional
importedAtstring | nullRead-onlyOptional
archivedAtstring | nullOptional
ownerstring | nullOptionalExample: /users/{id}
jobTitlestring | nullOptional
tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]
segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]
organizationsstring · iri-reference[]OptionalExample: ["/organizations/{id}"]
_organizationsstring[]Read-onlyOptionalDeprecated
avatarUrlstring | nullRead-onlyOptional
avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}
integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/
idstring | nullOptional
Responses
200
Person resource updated
put
PUT /people/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 573

{
  "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}",
  "integrationParticipants": [
    "https://example.com/"
  ],
  "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": [
    {
      "@context": "text",
      "@type": "text",
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "@context": "text",
      "@type": "text",
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "avatarUrl": null,
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

Partially update a person

patch

Updates specific fields of an existing person.

Authorizations
Path parameters
idstringRequired

Person identifier

Body

Represents a CRM contact person with details like name, email, phone, and tags.

familyNamestring | nullRequired
givenNamestring | nullOptional
additionalNamestring | nullOptional
initialsstring | nullOptional
customerIdstring | nullOptional
honorificPrefixstring | nullOptional
isTrackedboolean | nullOptional
linkedinIdstring | nullOptional
externalSourcestring | nullOptional
createdAtstring | nullRead-onlyOptional
updatedAtstring | nullRead-onlyOptional
importedAtstring | nullRead-onlyOptional
archivedAtstring | nullOptional
ownerstring | nullOptionalExample: /users/{id}
jobTitlestring | nullOptional
tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]
segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]
organizationsstring · iri-reference[]OptionalExample: ["/organizations/{id}"]
_organizationsstring[]Read-onlyOptionalDeprecated
avatarUrlstring | nullRead-onlyOptional
avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}
integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/
idstring | nullOptional
Responses
200
Person resource updated
patch
PATCH /people/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 573

{
  "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}",
  "integrationParticipants": [
    "https://example.com/"
  ],
  "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": [
    {
      "@context": "text",
      "@type": "text",
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "@context": "text",
      "@type": "text",
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "avatarUrl": null,
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

List person notes

get

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

Authorizations
Path parameters
personIdstringRequired

PersonNoteResource identifier

Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
qstringOptional
personstringOptional
person[]string[]Optional
category.idstringOptional
category.id[]string[]Optional
author.idstringOptional
author.id[]string[]Optional
flaggedbooleanOptional
order[flagged]string · enumOptionalPossible values:
order[createdAt]string · enumOptionalPossible values:
createdAt[strictly_after]stringOptional
createdAt[after]stringOptional
createdAt[strictly_before]stringOptional
createdAt[before]stringOptional
Responses
200
PersonNoteResource collection
get
GET /people/{personId}/notes HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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
      }
    ]
  }
}

Get person note

get

Retrieves a single note attached to a person.

Authorizations
Path parameters
personIdstringRequired

PersonNoteResource identifier

idstringRequired

PersonNoteResource identifier

Responses
200
PersonNoteResource resource
get
GET /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}

Create person note

post

Creates a new note linked to a specific person.

Authorizations
Path parameters
personIdstringRequired

PersonNoteResource identifier

Body

Represents a CRM note attached to a person, such as contact moments or meeting summaries.

@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
personIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
titlestring | nullOptional
flaggedboolean | nullOptional
isPrivateboolean | nullOptional
authorstring | nullOptionalExample: /users/{id}
categorystring | nullRequiredExample: /note_categories/{id}
Responses
201
PersonNoteResource resource created
post
POST /people/{personId}/notes HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}

Replace person note

put

Replaces all fields of a person note.

Authorizations
Path parameters
personIdstringRequired

PersonNoteResource identifier

idstringRequired

PersonNoteResource identifier

Body

Represents a CRM note attached to a person, such as contact moments or meeting summaries.

@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
personIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
titlestring | nullOptional
flaggedboolean | nullOptional
isPrivateboolean | nullOptional
authorstring | nullOptionalExample: /users/{id}
categorystring | nullRequiredExample: /note_categories/{id}
Responses
200
PersonNoteResource resource updated
put
PUT /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}

Update person note

patch

Updates one or more fields of a person note.

Authorizations
Path parameters
personIdstringRequired

PersonNoteResource identifier

idstringRequired

PersonNoteResource identifier

Body

Represents a CRM note attached to a person, such as contact moments or meeting summaries.

idstring | nullOptional
personIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
titlestring | nullOptional
flaggedboolean | nullOptional
isPrivateboolean | nullOptional
authorstring | nullOptionalExample: /users/{id}
categorystring | nullRequiredExample: /note_categories/{id}
Responses
200
PersonNoteResource resource updated
patch
PATCH /people/{personId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}
PreviousPaginationNextOrganizations

Last updated