Get an organization

GET

/organizations/{oid}

const url = 'https://apisandbox.puurk.com/organizations/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/organizations/example \
  --header 'Authorization: Bearer <token>'

Returns a single organization

Authorizations

service_token

Parameters

Path Parameters

oid

required

string

Organization ID

Responses

200

Successful operation

application/json

object

Unique identifier for the organization

string

eid

External identifier for the organization

string

name

Name of the organization

string

ein

Employer Identification Number

string

logo_path

Path to the organization’s logo

string

type

Type of organization. Validated on create and update; any other value is rejected with 400 Invalid type. Must be one of: client, test.

string

Allowed values: client test

roles

User roles in the organization

object

key

additional properties

Role of a user in an organization, as stored in the organization’s roles map. admin is not a role: it is a service-token scope action, and a request that sends it as a role gets 400. Of the organization roles, only owner and agencyadmin may change other members’ roles.

string

Allowed values: owner manager read write provider accountant officeadmin agencyadmin agencyuser none

settings

Organization settings

object

key

additional properties

boolean

features

Puurk features enabled for the organization

object

key

additional properties

boolean

Example

{
  "type": "client",
  "roles": {
    "additionalProperty": "owner"
  }
}

401

Unauthorized

404

Not found