Get Custom Tags
Gets a list of custom tags.
URLs
| Environment | Method | URL |
|---|---|---|
| Sandbox | https://api-sandbox.fndev.net/api/rest/v2/company/tags | |
| Production | https://api.fieldnation.com/api/rest/v2/company/tags |
Path Parameters
Not applicable.
Query Parameters
| Parameter | Type | Example | Notes |
|---|---|---|---|
| access_token | string | abc123defg459hijk786lmn45 | Required. |
Body
Not applicable.
Response
Examples
{
"actions":[
"add"
],
"metadata":{
"total":4,
"page":1,
"pages":1,
"per_page":5000,
"columns":"id,label,hex_color,valid_statuses,types",
"view":"model",
"sort":"",
"order":"asc"
},
"params":[],
"results":[
{
"id":1007,
"label":"Custom Tag",
"hex_color":"#F67B1E",
"valid_statuses":[
"created",
"published"
],
"types":[
"custom_company",
"for_providers_only",
"show_in_dashboard"
],
"actions":[
"edit"
]
},
{
"id":1010,
"label":"Custom Tag2",
"hex_color":"#453E39",
"valid_statuses":[
"paid",
"canceled"
],
"types":[
"custom_company",
"for_providers_only",
"show_in_dashboard"
],
"actions":[
"edit"
]
},
{
"id":1008,
"label":"Hidden Tag",
"hex_color":"#1E22F6",
"valid_statuses":[
"routed",
"assigned"
],
"types":[
"custom_company",
"hide_from_provider",
"show_in_dashboard"
],
"actions":[
"edit"
]
},
{
"id":1009,
"label":"Provider Edit",
"hex_color":"#1A8018",
"valid_statuses":[
"workdone",
"approved"
],
"types":[
"custom_company",
"provider_can_edit",
"for_providers_only",
"show_in_dashboard"
],
"actions":[
"edit"
]
}
]
}