The Branch object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

branch string required
The Branch object 
{
  "id": "branch_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "branch": "branch_example"
}
GET /api/setup/branch/{id}

Retrieve a branch

Retrieves the details of an existing branch. Supply the unique branch ID that was returned from a previous request.

Path parameters

id string required

The identifier of the branch to retrieve.

Returns

Returns the branch object if a valid identifier was provided.

GET /api/setup/branch/{id} 
curl https://api.overplane.dev/api/setup/branch/branch_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "branch_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "branch": "branch_example"
}
GET /api/setup/branch

List all branchs

Returns a list of branchs. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of branch objects.

GET /api/setup/branch 
curl https://api.overplane.dev/api/setup/branch \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "branch_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "branch": "branch_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/branch

Create a branch

Creates a new branch object.

Body parameters

branch string required

Returns

Returns the newly created branch object if the call succeeded.

POST /api/setup/branch 
curl https://api.overplane.dev/api/setup/branch \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"branch":"branch_example"}'
Response 
{
  "id": "branch_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "branch": "branch_example"
}
PATCH /api/setup/branch/{id}

Update a branch

Updates the specified branch by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the branch to update.

Body parameters

branch string

Returns

Returns the updated branch object.

PATCH /api/setup/branch/{id} 
curl https://api.overplane.dev/api/setup/branch/branch_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"branch":"branch_example"}'
Response 
{
  "id": "branch_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "branch": "branch_example"
}
DELETE /api/setup/branch/{id}

Delete a branch

Permanently deletes a branch. This cannot be undone.

Path parameters

id string required

The identifier of the branch to delete.

Returns

Returns a confirmation that the branch has been deleted.

DELETE /api/setup/branch/{id} 
curl https://api.overplane.dev/api/setup/branch/branch_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "branch_abc123",
  "deleted": true
}