Organizations
The organizations endpoint gives access to the organizations in the CRM.
Good to know:
An organization must always contain a title
Creates a new organization with email, phone numbers, and metadata.
Represents an organization in the CRM with name, contact details, tags, and related people.
/users/{id}
["/people/{id}"]
/media_objects/{id}
["/tags/{id}"]
["/segments/{id}"]
https://example.com/
POST /organizations HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 490
{
"description": null,
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": 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": [
{
"@context": "text",
"@type": "text",
"email": null
}
],
"phoneNumbers": [
{
"@context": "text",
"@type": "text",
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": null,
"createdAt": null,
"importedAt": null,
"updatedAt": null,
"archivedAt": null,
"address": {
"@context": "text",
"@id": "text",
"@type": "text",
"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/"
],
"id": null
}
Retrieve all notes associated with a given organization.
OrganizationNote identifier
The collection page number
1
The number of items per page
15
GET /organizations/{organizationId}/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
}
]
}
}
Retrieves the details of a single organization by its ID.
Organization identifier
GET /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"description": null,
"emailAddresses": [
{
"@context": "text",
"@type": "text",
"email": null
}
],
"phoneNumbers": [
{
"@context": "text",
"@type": "text",
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": null,
"createdAt": null,
"importedAt": null,
"updatedAt": null,
"archivedAt": null,
"address": {
"@context": "text",
"@id": "text",
"@type": "text",
"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/"
],
"id": null
}
Removes or archives a note.
OrganizationNoteResource identifier
OrganizationNoteResource identifier
DELETE /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Updates selected fields of a note.
OrganizationNoteResource identifier
OrganizationNoteResource identifier
/users/{id}
/note_categories/{id}
PATCH /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}
Fully replaces a note record by ID.
OrganizationNoteResource identifier
OrganizationNoteResource identifier
/users/{id}
/note_categories/{id}
PUT /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}
Returns a single note belonging to an organization.
OrganizationNoteResource identifier
OrganizationNoteResource identifier
GET /organizations/{organizationId}/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}"
}
Replaces all updatable fields of the organization.
Organization identifier
Represents an organization in the CRM with name, contact details, tags, and related people.
/users/{id}
["/people/{id}"]
/media_objects/{id}
["/tags/{id}"]
["/segments/{id}"]
https://example.com/
PUT /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 490
{
"description": null,
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": 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": [
{
"@context": "text",
"@type": "text",
"email": null
}
],
"phoneNumbers": [
{
"@context": "text",
"@type": "text",
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": null,
"createdAt": null,
"importedAt": null,
"updatedAt": null,
"archivedAt": null,
"address": {
"@context": "text",
"@id": "text",
"@type": "text",
"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/"
],
"id": null
}
Adds a new note to the given organization.
OrganizationNote identifier
Represents a note related to an organization, such as comments or annotations.
/users/{id}
/note_categories/{id}
POST /organizations/{organizationId}/notes HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
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}"
}
Updates one or more fields of the organization.
Organization identifier
Represents an organization in the CRM with name, contact details, tags, and related people.
/users/{id}
["/people/{id}"]
/media_objects/{id}
["/tags/{id}"]
["/segments/{id}"]
https://example.com/
PATCH /organizations/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 490
{
"description": null,
"emailAddresses": [
{
"email": null
}
],
"phoneNumbers": [
{
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": 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": [
{
"@context": "text",
"@type": "text",
"email": null
}
],
"phoneNumbers": [
{
"@context": "text",
"@type": "text",
"phoneNumber": null,
"phoneType": "fax"
}
],
"title": null,
"website": null,
"customerId": null,
"externalSource": null,
"chamberOfCommerceNumber": null,
"createdAt": null,
"importedAt": null,
"updatedAt": null,
"archivedAt": null,
"address": {
"@context": "text",
"@id": "text",
"@type": "text",
"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/"
],
"id": null
}
Last updated