Skip to main content
API docs by Redocly

Customer API (1.0.0)

Download OpenAPI specification:Download

Administrator

Admin users API

Create an administrator

Create a new administrator user. Admin users can only be created by another admin user. Unlike customers they are not connected to an organisation.

Authorizations:
jwt
Request Body schema: application/json
givenName
required
string
familyName
required
string
countryISO
required
string = 2 characters
email
required
string <hectare-email>

Hectare email address

phone
string or null <phone-number>

Phone number

password
string <cognito-password>

Standard cognito password

useMFA
boolean

Has multi factor authenitcation

status
string
Enum: "active" "inactive" "deleted" "pending" "verified"

Current status of the user

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "st",
  • "email": "string",
  • "phone": "string",
  • "password": "string",
  • "useMFA": true,
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Retrieve all administrators

Retrieves a list of administrators that are available in the platform. You can also use the query parameters to:

  • View the users without loading all of them at once, for example, return a specified number of users per page. (Pagination)
  • Sort the list (Sorting)
The response contains an array of User objects. To get the full details of a User object, use the Retrieve an administrator endpoint.

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an administrator

Retrieves a single administrator record.

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Update an administrator

Updates an administrators record. And changes to an an administrators email address will trigger a verification flow

Authorizations:
jwt
path Parameters
id
required
string

User Id

Request Body schema: application/json
givenName
string
familyName
string
countryISO
string
email
string
phone
string or null <phone-number>

Phone number

useMFA
boolean

Has multi factor authentication

status
string

Current status of the user

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": "string",
  • "useMFA": true,
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Delete administrator

Deletes an administrator from the system

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Business

Get Business

Retrieve business for a business unit

Authorizations:
jwt
path Parameters
id
required
string

Business Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "businessUnitId": "string",
  • "organisationId": "string",
  • "location": {
    },
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "assurance": {
    }
}

Get Red Tractor Certificates

Retrieve all valid or grace statused Red Tractor certifications for this business

Authorizations:
jwt
query Parameters
country
required
string = 3 characters
Default: "GBR"

ISO3 country code

postcode
string

Postcode of location

holdingNumber
string

Holding number for scheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Business Units

Create Business Unit

Create a new business unit within an organisation

Authorizations:
jwt
Request Body schema: application/json
organisationId
required
string

Organisation id to which the business units belong

name
required
string

The name of the business unit

type
required
string
Enum: "farm" "stores" "region"

The type of business unit being created

object

Responses

Request samples

Content type
application/json
{
  • "organisationId": "string",
  • "name": "string",
  • "type": "farm",
  • "business": {
    }
}

Response samples

Content type
application/json
{
  • "ordinal": 0,
  • "id": "string",
  • "name": "string",
  • "type": "farm",
  • "business": {
    },
  • "storeCount": 0,
  • "fieldCount": 0
}

Get BusinessUnit

Retrieve business units for an organisation all of them without filtering by users business units

Authorizations:
jwt
path Parameters
id
required
string

Business Unit Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisationId": "string",
  • "organisationName": "string",
  • "businessUnits": [
    ]
}

Get BusinessUnit

Retrieve business units for an organisation filtered by user

Authorizations:
jwt
path Parameters
id
required
string

Business Unit Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisationId": "string",
  • "organisationName": "string",
  • "businessUnits": [
    ]
}

Update Business Unit

Updates an Organisations business unit properties

Authorizations:
jwt
path Parameters
id
required
string

Business Unit Id

Request Body schema: application/json
name
string or null

The name of the business unit

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "business": {
    }
}

Response samples

Content type
application/json
{
  • "ordinal": 0,
  • "id": "string",
  • "name": "string",
  • "type": "farm",
  • "business": {
    },
  • "storeCount": 0,
  • "fieldCount": 0
}

Delete Business Unit

Delete Business Unit

Authorizations:
jwt
path Parameters
id
required
string

Business Unit Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Business Connections

Business connections are organisations with whom customers have a business relationship. This entity stores contacts, and other meta data associated with the relationship

Create Business Connection

Creates a new business connection for a customer. This endpoint requires that a user has a valid access token and will uses their own organisation id to attach the busines connection. When a connection object is passed to the endpoint, it will create any contacts sent with payload as users in the organisation. These users are not standard users, they will have a password generated for them, but they will not recieve an invitation email to set up their account in the platform.

Authorizations:
jwt
Request Body schema: application/json
id
string or null

The ID of any existing organisation that is to be connected to the calling organisation

companyNumber
string or null <company-number>

Legal number associated with an incorporated business

countryISO
string

Country where the business is based

name
string

Name of the business

isPreferred
boolean or null

Sets the new organisation as preferred if it is a new connection

type
Array of strings or null
Enum: "carrier" "farm-management" "broker" "consolidator" "other"

types of business e.g. Carrier, Broker, Consolidator etc

required
Array of objects or objects

The contact records that are to be stored agains the new organisation or an existing organisation

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "companyNumber": "string",
  • "countryISO": "string",
  • "name": "string",
  • "isPreferred": true,
  • "type": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "connectedOrganisations": [
    ]
}

Get Business Connections

Retrieves the business connection record for the organisation The response includes all contacts that belong to the organisation connected

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

tags
string

Filter by tags

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "connectedOrganisations": [
    ]
}

Delete Business Connection

Removes an organisation from the connected businesses of the calling organisation. Will return the business connection record with the remaining connected organisations and their contacts

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Delete contact

Removes a contact from a connected organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

userId
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Cognito

Manage user syncing from Cognito to Database and vice versa.

Create users in Cognito

Creates users in Cognito from the user account in RavenDB. All RavenDB users will be recreated

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Swap a user from one pool to another on login

Swap a user from one pool to another on login

Request Body schema: application/json
username
required
string
password
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "status": "not-found",
  • "authenticated": true,
  • "id": "string"
}

Create User in Cognito

Create a user in Cognito from a user account in RavenDB

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Sync to Cognito

Sync user record from a RavenDB user to Cognito

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "phone": {
    },
  • "useMFA": true,
  • "status": "active"
}

Sync from Cognito

Sync information from Cognito to RavenDB for a single user

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Sync Cognito to RavenDB

Sync information from Cognito to RavenDB for users from one or all organisations

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Customers

Customers of Platform are always organisations. We assign permissions to users created within those customer organisations. The users within those organisations have different roles, which allow them to carry out tasks within the system.

Customer Invite

Invites a new business to Platform and connects this business to the org that sent the invite out

Authorizations:
jwt
Request Body schema: application/json
id
string or null
companyNumber
string or null <company-number>

Legal number associated with an incorporated business

countryISO
required
string

Country where the business is based

name
required
string

Name of the business

required
object

Company admin/owner user

isPreferred
boolean

Sets the new organisation as preferred if it is a new connection

type
Array of strings or null
Enum: "carrier" "farm-management" "broker" "consolidator" "other"

types of business e.g. Carrier, Broker, Consolidator etc

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "companyNumber": "string",
  • "countryISO": "string",
  • "name": "string",
  • "ownerContact": {
    },
  • "isPreferred": true,
  • "type": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Customer self-signup

Users of Platform can sign themselves up to the Inventory and Trading service using this endpoint. Eventually the Logistics servic will be migrated here also

Authorizations:
jwt
Request Body schema: application/json
required
object
required
object or object

Responses

Request samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    }
}

Customer exists

Checks to see if a customer exists in the database with the same basic details. This endpoint does a check on the owner email address to see if there is an active or pending organisation in the db with an exact match owner contact email address.

If that check passes it will do a fuzzy check for and organisation with the same name, where the owner contact email address has the same domain and the country is the same and the status is either active or pending.

If any matches are found it will send them back with the response

query Parameters
name
required
string

Company name

number
string or null <company-number>

Company legal registration number

taxId
string

Company Tax ID number

countryISO
required
string <= 2 characters

Country code

email
required
string

Contacts email address

phone
string

Company name

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "organisation": {
    }
}

Customer profile

Retrieves the logged in customers profile (user & org)

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    },
  • "access": {
    },
  • "features": {
    }
}

Impersonate an organisation

Returns an encrypted impersonation token valid for 1 hour

Authorizations:
jwt
query Parameters
organisationId
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Complete signup

Complete the customer self signup, which was started via an invitation. Users of Platform can sign themselves up to the Inventory and Trading service using this endpoint. Eventually the Logistics servic will be migrated here also

path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
required
object
required
object or object

Responses

Request samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    }
}

Organisations

This API manages the organisation information of customers of Platform

Create organisation

Create a new customers organisation

Authorizations:
jwt
Request Body schema: application/json
required
object or null
bio
string
companyHoldingNumber
string

identification number for your farm or business which pinpoints the location of the land.

companyNumber
string or null <company-number>

Legal number associated with an incorporated business

companySalesTaxId
string

Tax id associated with the business

inventoryType
Array of strings

Type of inventory this organisation produces

object or null
name
required
string

Name of the business

referrer
required
string
Enum: "self-service" "admin-sign-up" "invitation"

how the organisaton was signed up

website
string

url of the company website

countryISO
required
string
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based

phone
string or null <phone-number>

Phone number

type
Array of strings or null
Enum: "carrier" "farm-management" "broker" "consolidator" "other"

types of business e.g. Carrier, Broker, Consolidator etc

required
object or null
required
Array of objects
connections
Array of strings

ids of the organisations that are connected to this organisation

flags
object
status
string
Enum: "active" "inactive" "pending"
required
object or object

Company admin/owner user

object
preferred
Array of strings

Organisations that are preferred by this org

preferredBy
Array of strings

Organisations that this organisation are preferred by

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "bio": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "referrer": "self-service",
  • "website": "string",
  • "countryISO": "GB",
  • "phone": "string",
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ],
  • "connections": [
    ],
  • "flags": { },
  • "status": "active",
  • "ownerContact": {
    },
  • "businessUnits": {
    },
  • "preferred": [
    ],
  • "preferredBy": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Get Organisations

Get Organisations

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

tags
string

Filter by tags

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organisations by id

Get organisations records by id

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Organisation

Get Organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Update Organisation

Updates an Organisations properties

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
object or null
bio
string or null
companyHoldingNumber
string or null

identification number for your farm or business which pinpoints the location of the land.

companyNumber
string or null <company-number>

Legal number associated with an incorporated business

companySalesTaxId
string or null

Tax id associated with the business

inventoryType
Array of strings or null

Type of inventory this organisation produces

object or null
name
string or null

Name of the business

referrer
string or null
Enum: "self-service" "admin-sign-up" "invitation"

how the organisaton was signed up

website
string or null

url of the company website

countryISO
string or null
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based

phone
string or null <phone-number>

Phone number

type
Array of strings or null
Enum: "carrier" "farm-management" "broker" "consolidator" "other"

types of business e.g. Carrier, Broker, Consolidator etc

object or null
Array of objects

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "bio": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "referrer": "self-service",
  • "website": "string",
  • "countryISO": "GB",
  • "phone": "string",
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Delete Organisation

Delete Organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get Connected Organisations

Get Connected Organisations

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

delete Connected Organisations

delete Connected Organisations

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Set as Preferred

Sets an organisation as preferred by another

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Delete as Preferred

Removes an organisation as preferred by another

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Roles

Returns a list of roles grouped by functional area

Returns a list of roles grouped by functional area

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Users

Change Owner

Changes the owner of the organisation

Authorizations:
jwt
Request Body schema: application/json
newOwnerUserId
required
string

The user id to be the new owner

Responses

Request samples

Content type
application/json
{
  • "newOwnerUserId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "bio": "string",
  • "website": "string",
  • "companyHoldingNumber": "string",
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "connections": [
    ],
  • "countryISO": "GB",
  • "inventoryType": [
    ],
  • "logo": {
    },
  • "name": "string",
  • "ownerContact": {
    },
  • "phone": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "businessConnections": [
    ],
  • "preferred": [
    ],
  • "preferredBy": [
    ],
  • "type": [
    ],
  • "billing": {
    },
  • "modules": [
    ]
}

Delete User

Delete User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get User

Get User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "string",
  • "email": "string",
  • "impersonating": false,
  • "groups": [
    ],
  • "roles": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "referrer": "string",
  • "organisationId": "string",
  • "authPlatformId": "string",
  • "useMFA": true,
  • "status": "active",
  • "permissions": [
    ],
  • "businessUnits": [
    ]
}

Patch User

Patch User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Request Body schema: application/json
givenName
string or null
familyName
string or null
countryISO
string or null
email
string or null
roles
Array of strings or null

The role this user has

permissions
Array of strings or null

The permissions that the user should have (obsolete use roles)

phone
string or null <phone-number>

Phone number

phoneLandline
string or null <phone-number>

Phone number

referrer
string or null

This is how the user was referred

useMFA
boolean or null

Has multi factor authenitcation

status
string or null

Current status of the user

organisationId
string or null

The organisation this user belongs too

object or null
businessUnits
Array of strings or null

The user business units, list of ids

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "roles": [
    ],
  • "permissions": [
    ],
  • "phone": "string",
  • "phoneLandline": "string",
  • "referrer": "string",
  • "useMFA": true,
  • "status": "string",
  • "organisationId": "string",
  • "avatar": {
    },
  • "businessUnits": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "string",
  • "email": "string",
  • "impersonating": false,
  • "groups": [
    ],
  • "roles": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "referrer": "string",
  • "organisationId": "string",
  • "authPlatformId": "string",
  • "useMFA": true,
  • "status": "active",
  • "permissions": [
    ],
  • "businessUnits": [
    ]
}

Resend the users password

Resend users temporary password (resend invite)

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get Users

Get Users

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user

Create a new customer user. This endpoint can only be used by team owners creating users for their organisation

Authorizations:
jwt
Request Body schema: application/json
Any of
givenName
required
string
familyName
required
string
countryISO
required
string
email
required
string
groups
Array of strings

The role this user has

roles
Array of strings

The role this user has

permissions
Array of strings

The role this user has (obsolete just use roles)

phone
string or null <phone-number>

Phone number

phoneLandline
string or null <phone-number>

Phone number

password
string <cognito-password>

Standard cognito password

referrer
string

This is how the user was referred

useMFA
boolean

Has multi factor authenitcation

organisationId
string

The ID of the organisation

object or null
status
string
Enum: "active" "inactive" "deleted" "pending" "verified"

Current status of the user

businessUnits
Array of strings

The user business units, list of ids

createdByUserId
string

This id of the user that created the record

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "string",
  • "email": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "permissions": [
    ],
  • "phone": "string",
  • "phoneLandline": "string",
  • "password": "string",
  • "referrer": "string",
  • "useMFA": true,
  • "organisationId": "string",
  • "avatar": {
    },
  • "status": "active",
  • "businessUnits": [
    ],
  • "createdByUserId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "string",
  • "email": "string",
  • "impersonating": false,
  • "groups": [
    ],
  • "roles": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "referrer": "string",
  • "organisationId": "string",
  • "authPlatformId": "string",
  • "useMFA": true,
  • "status": "active",
  • "permissions": [
    ],
  • "businessUnits": [
    ]
}

Verify Attribute Update

User update email and phone attribute confirmation, takes a username and a confirmation code and sets the users account to confirmed, allowing that user to login

Authorizations:
jwt
Request Body schema: application/json
code
required
string

Six digit code sent to user to confirm their update

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

System

Get Feature Flags

Returns a list of active feature flags and whether they are enabled or disabled

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Set Feature Flags

Sets an array of feature flags to either enabled or disabled

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Delete Feature Flag

Delete a feature flag

Authorizations:
jwt
path Parameters
id
required
string

Feature Flag Name

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Feature Flags

Get Feature Flags

Returns a list of active feature flags and whether they are enabled or disabled

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Set Feature Flags

Sets an array of feature flags to either enabled or disabled

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Delete Feature Flag

Delete a feature flag

Authorizations:
jwt
path Parameters
id
required
string

Feature Flag Name

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Customers service

Ping api

Ping customers api

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Execute event

Execute event in customers module

Authorizations:
jwt
path Parameters
action
required
string

Action to perform

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update system settings

Change the system settings document in the customers module

Authorizations:
jwt
Request Body schema: application/json
required
object
level
required
string
filter
required
string or null

Responses

Request samples

Content type
application/json
{
  • "logging": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}