PlayHQ External API (1.0.0)

Download OpenAPI specification:Download

External API to exposing with playhq services.

Organisations

Lists all organisations

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters
page
number [ 0 .. totalPages in response metadata ]
Default: 1

Page Number to fetch data

limit
number [ 1 .. 100 ]
Default: 10

Number of objects per page to return

changedSince
string

Date in ISO 8601 format to fetch updates since

type
string

One of CLUB, ASSOCIATION, ADMINISTRATIVE_BODY or ALL. Defaults to ALL

header Parameters
Authorization
required
string

Bearer {JWT_Auth_Token}

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {
    }
}

Organisation Created Webhook

Information about a new organisation

header Parameters
signature
string
Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json
messageId
string

The unique identifier for the event message

entityId
string

The unique identifier for the record

eventRaisedDateTime
string

The time the event occurred, as an ISO 8601 string

eventType
string
Value: "ORGANISATION.CREATED"
object

Responses

Request samples

Content type
application/json
{
  • "messageId": "string",
  • "entityId": "string",
  • "eventRaisedDateTime": "string",
  • "eventType": "ORGANISATION.CREATED",
  • "data": {
    }
}

Organisation Updated Webhook

Information about an existing organisation which has been updated

header Parameters
signature
string
Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json
messageId
string

The unique identifier for the event message

entityId
string

The unique identifier for the record

eventRaisedDateTime
string

The time the event occurred, as an ISO 8601 string

eventType
string
Value: "ORGANISATION.UPDATED"
object

Responses

Request samples

Content type
application/json
{
  • "messageId": "string",
  • "entityId": "string",
  • "eventRaisedDateTime": "string",
  • "eventType": "ORGANISATION.UPDATED",
  • "data": {