Get branch

GET 
/api/v2/Branches/:key

Get branch

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example: 2024-10-07T12:48:00Z
Name stringnullablerequired
Code stringnullable
ExternalKey stringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-10-07T12:48:00Z",
  "TimestampChanged": "2024-10-07T12:48:00Z",
  "Name": "string",
  "Code": "string",
  "ExternalKey": "string"
}

404

Not found

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example: 2024-10-07T12:48:00Z
Name stringnullablerequired
Code stringnullable
ExternalKey stringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-10-07T12:48:00Z",
  "TimestampChanged": "2024-10-07T12:48:00Z",
  "Name": "string",
  "Code": "string",
  "ExternalKey": "string"
}

Loading...