My Developer Account

Tab

A tab is a custom tab and groups like field definitions.

Example Request 

curl https://api.planningcenteronline.com/people/v2/tabs

View in API Explorer →

Example Object 

{
  "type": "Tab",
  "id": "1",
  "attributes": {
    "name": "string",
    "sequence": 1,
    "slug": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
id primary_key
name string
sequence integer
slug string

Can Include

Parameter Value Description Assignable
include field_definitions

include associated field_definitions
include field_options

include associated field_options

Order By

Parameter Value Type Description
order name string

prefix with a hyphen (-name) to reverse the order
order sequence string

prefix with a hyphen (-sequence) to reverse the order
order slug string

prefix with a hyphen (-slug) to reverse the order
order slug string

prefix with a hyphen (-slug) to reverse the order

Query By

Name Parameter Type Description Example
name where[name] string

Query on a specific name

 ?where[name]=string
sequence where[sequence] integer

Query on a specific sequence

 ?where[sequence]=1
slug where[slug] string

Query on a specific slug

 ?where[slug]=string

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)
offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /people/v2/tabs

Reading

HTTP Method Endpoint
GET /people/v2/tabs/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/tabs
  • name
  • sequence
  • slug

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/tabs/{id}
  • name
  • sequence
  • slug

Deleting

HTTP Method Endpoint
DELETE /people/v2/tabs/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/tabs/{tab_id}/field_definitions FieldDefinition
  • with_deleted
GET https://api.planningcenteronline.com/people/v2/tabs/{tab_id}/field_options FieldOption

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/field_data/{field_datum_id}/tab FieldDatum
GET https://api.planningcenteronline.com/people/v2/field_definitions/{field_definition_id}/tab FieldDefinition
GET https://api.planningcenteronline.com/people/v2/tabs Organization
  • with_field_definitions