Organizations

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

Good to know:

An organization must always contain a title

Create an organization

post

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

Authorizations

Body

Represents an organization in the CRM with name, contact details, tags, and related people.

descriptionstring | nullOptional

titlestring | nullRequired

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

linkedinIdstring | nullOptional

linkedinPublicIdentifierstring | nullRead-onlyOptional

linkedinInternalIdstring | nullRead-onlyOptional

createdAtstring | nullRead-onlyOptional

importedAtstring | nullRead-onlyOptional

updatedAtstring | nullRead-onlyOptional

archivedAtstring | nullOptional

ownerstring | nullOptionalExample: /users/{id}

peoplestring · iri-reference[]OptionalExample: ["/people/{id}"]

avatarUrlstring | nullRead-onlyOptional

avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}

tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]

segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]

integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/

companyEnrichmentboolean | nullRead-onlyOptional

linkedinCompanyEnrichmentarray | nullRead-onlyOptional

idstring | nullOptional

Responses

201

Organization resource created

400

Invalid input

403

Forbidden

422

An error occurred

post

/organizations

POST /organizations HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 508

{
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatar": "/media_objects/{id}",
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "linkedinPublicIdentifier": null,
  "linkedinInternalId": null,
  "createdAt": null,
  "importedAt": null,
  "updatedAt": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatarUrl": null,
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "companyEnrichment": null,
  "linkedinCompanyEnrichment": [
    null
  ],
  "id": null
}

List organization notes

get

Retrieve all notes associated with a given organization.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNote identifier

Query parameters

pageintegerOptional

The collection page number

Default: 1

itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15

qstringOptional

organizationstringOptional

organization[]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

OrganizationNote collection

403

Forbidden

get

/organizations/{organizationId}/notes

GET /organizations/{organizationId}/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
      }
    ]
  }
}

Get an organization

get

Retrieves the details of a single organization by its ID.

Authorizations

Path parameters

idstringRequired

Organization identifier

Responses

200

Organization resource

403

Forbidden

404

Not found

get

/organizations/{id}

GET /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "linkedinPublicIdentifier": null,
  "linkedinInternalId": null,
  "createdAt": null,
  "importedAt": null,
  "updatedAt": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatarUrl": null,
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "companyEnrichment": null,
  "linkedinCompanyEnrichment": [
    null
  ],
  "id": null
}

List organizations

get

Returns a filtered, paginated list of CRM organizations.

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[title.sort]string · enumOptionalPossible values:

order[owner.lastName]string · enumOptionalPossible values:

createdAt[strictly_after]stringOptional

createdAt[after]stringOptional

createdAt[strictly_before]stringOptional

createdAt[before]stringOptional

identifiersstringOptional

Filter by identifiers (searches LinkedIn IDs, email addresses, and phone numbers)

identifiers[]stringOptional

Filter by multiple identifiers

Responses

200

Organization collection

403

Forbidden

get

/organizations

GET /organizations HTTP/1.1
Host: api.rogerroger.io
Accept: */*

{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "description": null,
      "emailAddresses": [
        {
          "email": null
        }
      ],
      "phoneNumbers": [
        {
          "phoneNumber": null,
          "phoneType": "fax"
        }
      ],
      "title": null,
      "website": null,
      "customerId": null,
      "externalSource": null,
      "chamberOfCommerceNumber": null,
      "linkedinId": null,
      "linkedinPublicIdentifier": null,
      "linkedinInternalId": null,
      "createdAt": null,
      "importedAt": null,
      "updatedAt": null,
      "archivedAt": null,
      "address": {
        "city": null,
        "postalCode": null,
        "street": null,
        "country": "NL"
      },
      "owner": "/users/{id}",
      "people": [
        "/people/{id}"
      ],
      "avatarUrl": null,
      "tags": [
        "/tags/{id}"
      ],
      "segments": [
        "/segments/{id}"
      ],
      "integrationParticipants": [
        "https://example.com/"
      ],
      "companyEnrichment": null,
      "linkedinCompanyEnrichment": [
        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
      }
    ]
  }
}

Delete organization note

delete

Removes or archives a note.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNoteResource identifier

idstringRequired

OrganizationNoteResource identifier

Responses

204

OrganizationNoteResource resource deleted

403

Forbidden

404

Not found

delete

/organizations/{organizationId}/notes/{id}

DELETE /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*

No content

Update organization note

patch

Updates selected fields of a note.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNoteResource identifier

idstringRequired

OrganizationNoteResource identifier

Body

idstring | nullOptional

organizationIdstring | nullWrite-onlyOptional

createdAtstring | nullOptional

descriptionstring | nullOptional

titlestring | nullOptional

flaggedboolean | nullOptional

isPrivateboolean | nullOptional

authorstring | nullOptionalExample: /users/{id}

categorystring | nullOptionalExample: /note_categories/{id}

Responses

200

OrganizationNoteResource resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

patch

/organizations/{organizationId}/notes/{id}

PATCH /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 172

{
  "id": null,
  "organizationId": 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 organization note

put

Fully replaces a note record by ID.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNoteResource identifier

idstringRequired

OrganizationNoteResource identifier

Body

idstring | nullOptional

organizationIdstring | nullWrite-onlyOptional

createdAtstring | nullOptional

descriptionstring | nullRequired

titlestring | nullOptional

flaggedboolean | nullOptional

isPrivateboolean | nullOptional

authorstring | nullOptionalExample: /users/{id}

categorystring | nullRequiredExample: /note_categories/{id}

Responses

200

OrganizationNoteResource resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put

/organizations/{organizationId}/notes/{id}

PUT /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 172

{
  "id": null,
  "organizationId": 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}"
}

Retrieve organization note

get

Returns a single note belonging to an organization.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNoteResource identifier

idstringRequired

OrganizationNoteResource identifier

Responses

200

OrganizationNoteResource resource

403

Forbidden

404

Not found

get

/organizations/{organizationId}/notes/{id}

GET /organizations/{organizationId}/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}"
}

Replace an organization

put

Replaces all updatable fields of the organization.

Authorizations

Path parameters

idstringRequired

Organization identifier

Body

Represents an organization in the CRM with name, contact details, tags, and related people.

descriptionstring | nullOptional

titlestring | nullRequired

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

linkedinIdstring | nullOptional

linkedinPublicIdentifierstring | nullRead-onlyOptional

linkedinInternalIdstring | nullRead-onlyOptional

createdAtstring | nullRead-onlyOptional

importedAtstring | nullRead-onlyOptional

updatedAtstring | nullRead-onlyOptional

archivedAtstring | nullOptional

ownerstring | nullOptionalExample: /users/{id}

peoplestring · iri-reference[]OptionalExample: ["/people/{id}"]

avatarUrlstring | nullRead-onlyOptional

avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}

tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]

segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]

integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/

companyEnrichmentboolean | nullRead-onlyOptional

linkedinCompanyEnrichmentarray | nullRead-onlyOptional

idstring | nullOptional

Responses

200

Organization resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put

/organizations/{id}

PUT /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 508

{
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatar": "/media_objects/{id}",
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "linkedinPublicIdentifier": null,
  "linkedinInternalId": null,
  "createdAt": null,
  "importedAt": null,
  "updatedAt": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatarUrl": null,
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "companyEnrichment": null,
  "linkedinCompanyEnrichment": [
    null
  ],
  "id": null
}

Create a new organization note

post

Adds a new note to the given organization.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNote identifier

Body

Represents a note related to an organization, such as comments or annotations.

idstring | nullOptional

organizationIdstring | nullWrite-onlyOptional

createdAtstring | nullOptional

descriptionstring | nullRequired

titlestring | nullOptional

flaggedboolean | nullOptional

isPrivateboolean | nullOptional

authorstring | nullOptionalExample: /users/{id}

categorystring | nullRequiredExample: /note_categories/{id}

Responses

201

OrganizationNote resource created

400

Invalid input

403

Forbidden

422

An error occurred

post

/organizations/{organizationId}/notes

POST /organizations/{organizationId}/notes HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 172

{
  "id": null,
  "organizationId": 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}"
}

Partially update an organization

patch

Updates one or more fields of the organization.

Authorizations

Path parameters

idstringRequired

Organization identifier

Body

Represents an organization in the CRM with name, contact details, tags, and related people.

descriptionstring | nullOptional

titlestring | nullOptional

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

linkedinIdstring | nullOptional

linkedinPublicIdentifierstring | nullRead-onlyOptional

linkedinInternalIdstring | nullRead-onlyOptional

createdAtstring | nullRead-onlyOptional

importedAtstring | nullRead-onlyOptional

updatedAtstring | nullRead-onlyOptional

archivedAtstring | nullOptional

ownerstring | nullOptionalExample: /users/{id}

peoplestring · iri-reference[]OptionalExample: ["/people/{id}"]

avatarUrlstring | nullRead-onlyOptional

avatarstring | nullWrite-onlyOptionalExample: /media_objects/{id}

tagsstring · iri-reference[]OptionalExample: ["/tags/{id}"]

segmentsstring · iri-reference[]OptionalExample: ["/segments/{id}"]

integrationParticipantsstring · iri-reference[]OptionalExample: https://example.com/

companyEnrichmentboolean | nullRead-onlyOptional

linkedinCompanyEnrichmentarray | nullRead-onlyOptional

idstring | nullOptional

Responses

200

Organization resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

patch

/organizations/{id}

PATCH /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 508

{
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatar": "/media_objects/{id}",
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "id": null
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "description": null,
  "emailAddresses": [
    {
      "email": null
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": null,
      "phoneType": "fax"
    }
  ],
  "title": null,
  "website": null,
  "customerId": null,
  "externalSource": null,
  "chamberOfCommerceNumber": null,
  "linkedinId": null,
  "linkedinPublicIdentifier": null,
  "linkedinInternalId": null,
  "createdAt": null,
  "importedAt": null,
  "updatedAt": null,
  "archivedAt": null,
  "address": {
    "city": null,
    "postalCode": null,
    "street": null,
    "country": "NL"
  },
  "owner": "/users/{id}",
  "people": [
    "/people/{id}"
  ],
  "avatarUrl": null,
  "tags": [
    "/tags/{id}"
  ],
  "segments": [
    "/segments/{id}"
  ],
  "integrationParticipants": [
    "https://example.com/"
  ],
  "companyEnrichment": null,
  "linkedinCompanyEnrichment": [
    null
  ],
  "id": null
}

PreviousPeople NextLists

Last updated 2 months ago

hashtagCreate an organization

hashtagList organization notes

hashtagGet an organization

hashtagList organizations

hashtagDelete organization note

hashtagUpdate organization note

hashtagReplace organization note

hashtagRetrieve organization note

hashtagReplace an organization

hashtagCreate a new organization note

hashtagPartially update an organization

Create an organization

List organization notes

Get an organization

List organizations

Delete organization note

Update organization note

Replace organization note

Retrieve organization note

Replace an organization

Create a new organization note

Partially update an organization