Organizations

Introduction

Managing the organizations available is done through the /public/v2/management/organizations (management), this is different from the public/v2/organizations (standard) endpoint as shown in the table below.

Feature
Management
Standard

create

x

update

x

x

delete

x

show

x

x

list

x

x (only self)

token

x

access

Partner Key

Organization Key

Management access is scoped to Partner, this is different from Organization. Partner/management operations are meant to operate on the Organizations that a Partner manages, Organization scope is used for all resources belonging to that organization.

Basic usage

In order to get started with the Recrubo API you'll need to have received a Partner Access token. This allows you to start creating an Organization. Once you've created the Organization you can use the token of that organization to create Users, Vacancies, Candidates, etc..

The token field is only visible through the Management endpoint and cannot be accessed through the standard route.

Refresh Access Token

In case you want to regenerate the access token of an organization you can do so by POST /public/v2/management/refresh-token/{organizationId} without a body. This will return the full Organization including the token field with the newly generated token.

OpenAPI

Get all Partner Organizations

get
Authorizations
Responses
200

Organizations Fetched

application/vnd.api+json
get
GET /public/v2/management/organizations/ HTTP/1.1
Host: {defaulthost}
Authorization: YOUR_API_KEY
Accept: */*
200

Organizations Fetched

{
  "data": [
    {
      "id": "6e6816eb-fc1d-42bd-bb00-eff973ad207d",
      "type": "organizations",
      "attributes": {
        "createdAt": "2024-08-20T10:45:07+00:00",
        "updatedAt": "2021-08-24T15:07:35+00:00",
        "name": "Recrubo_89495632",
        "webhookUrl": null,
        "webhookSecret": null,
        "token": null
      },
      "relationships": {
        "users": {
          "links": {
            "related": "/public/v2/users?filter[organizationId]=6e6816eb-fc1d-42bd-bb00-eff973ad207d"
          }
        }
      }
    },
    {
      "id": "54175e6c-ca94-4d47-a5f9-ab10c801e13d",
      "type": "organizations",
      "attributes": {
        "createdAt": "2024-08-20T10:45:07+00:00",
        "updatedAt": "2021-08-24T15:07:35+00:00",
        "name": "Recrubo_82361056",
        "webhookUrl": null,
        "webhookSecret": null,
        "token": null
      },
      "relationships": {
        "users": {
          "links": {
            "related": "/public/v2/users?filter[organizationId]=54175e6c-ca94-4d47-a5f9-ab10c801e13d"
          }
        }
      }
    }
  ],
  "meta": {
    "total": 2,
    "totalUnfiltered": 2,
    "currentSize": 25,
    "currentPage": 1,
    "maxPage": 1
  }
}

Create an Organization

post
Authorizations
Body
Responses
201

Organization created

application/vnd.api+json
post
POST /public/v2/management/organizations/ HTTP/1.1
Host: {defaulthost}
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 123

{
  "data": {
    "id": "text",
    "type": "text",
    "attributes": {
      "name": "text",
      "webhookUrl": "text",
      "webhookSecret": "text",
      "token": "text"
    }
  }
}
201

Organization created

{
  "data": {
    "id": "303f151b-3f33-4ddd-9779-eb522f7225a9",
    "type": "organizations",
    "attributes": {
      "createdAt": "2024-08-20T10:45:07+00:00",
      "updatedAt": "2021-08-24T15:07:35+00:00",
      "name": "Test Org",
      "webhookUrl": null,
      "webhookSecret": null,
      "token": "5I9cezE6QPYl8v9jggrN3w"
    },
    "relationships": {
      "users": {
        "links": {
          "related": "/public/v2/users?filter[organizationId]=303f151b-3f33-4ddd-9779-eb522f7225a9"
        }
      }
    }
  },
  "meta": {}
}

Update a specific organization by id

patch
Authorizations
Path parameters
idstringRequired
Body
Responses
200

organization updated

No content
patch
PATCH /public/v2/management/organizations/{id} HTTP/1.1
Host: {defaulthost}
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 123

{
  "data": {
    "id": "text",
    "type": "text",
    "attributes": {
      "name": "text",
      "webhookUrl": "text",
      "webhookSecret": "text",
      "token": "text"
    }
  }
}
200

organization updated

No content

Delete a Partner Organizations

delete
Authorizations
Path parameters
idstringRequired
Responses
204

Organization Deleted

No content
delete
DELETE /public/v2/management/organizations/{id} HTTP/1.1
Host: {defaulthost}
Authorization: YOUR_API_KEY
Accept: */*
204

Organization Deleted

No content
Previousvacancy_application_flow

Last updated