Organizations | RogerRoger

Go to app

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

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
      }
    ]
  }
}

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

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
}

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

DELETE /organizations/{organizationId}/notes/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

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

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}"
}

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.

@contextone ofRead-onlyOptional

stringOptional

@idstringRead-onlyOptional

@typestringRead-onlyOptional

descriptionstring | nullOptional

titlestring | nullRequired

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

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/

idstring | nullOptional

Responses

201

Organization resource created

400

Invalid input

403

Forbidden

422

An error occurred

post

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
}

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 | 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

patch

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}"
}

Replace organization note

put

Fully replaces a note record by ID.

Authorizations

Path parameters

organizationIdstringRequired

OrganizationNoteResource identifier

idstringRequired

OrganizationNoteResource identifier

Body

@contextone ofRead-onlyOptional

stringOptional

@idstringRead-onlyOptional

@typestringRead-onlyOptional

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

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}"
}

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.

@contextone ofRead-onlyOptional

stringOptional

@idstringRead-onlyOptional

@typestringRead-onlyOptional

descriptionstring | nullOptional

titlestring | nullRequired

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

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/

idstring | nullOptional

Responses

200

Organization resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put

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
}

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.

@contextone ofRead-onlyOptional

stringOptional

@idstringRead-onlyOptional

@typestringRead-onlyOptional

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

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}"
}

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 | nullRequired

websitestring | nullOptional

customerIdstring | nullOptional

externalSourcestring | nullOptional

chamberOfCommerceNumberstring | nullOptional

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/

idstring | nullOptional

Responses

200

Organization resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

patch

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
}