is now

API-Documentation I

Last update: June 27, 2025

Picture of Sharan Murali
Sharan Murali

Technical Writer

In this article:

Some of the most powerful features in servis.ai exist in a low-code environment.  The coding process is quick and easy! You’ll need full access to our API and/or refer to the use-case tutorials in this Knowledge Base with copy-and-paste code to hit the ground running.

With servis.ai API you can do everything in servis.ai CRM’s Web Interface allowing you to interact with other applications (API stands for Application Programming Interface).

Through the GraphQL API you can perform any typical CRUD operations (create, read, update, delete) on any of your Apps whether they are our out-of-the-box Apps such as Contacts, Deals, Accounts, Tasks, or any Custom App you create. You can create Notes or Tasks as well!

Unleash the power of Servis.ai APIs with our curated collection of requests for Postman! This collection provides a valuable starting point for exploring various APIs. If you are new to Postman? No worries! Before diving in, we recommend checking out Postman’s basic documentation to get comfortable with the tool.

Ready to Get Started? Click here to download the Servis.ai Postman collection and unlock the full potential of Servis.ai APIs!

Bulk Delete App Records

Delete one or multiple records for any of your apps.

If you delete more than 250 records, the process will occur in an async process and can be tracked in the Jobs page. The sent_to_job response value will be “True”

GraphQL Parameters

!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

pattern String Search pattern, you can add any string value to search for any text field in your records.
!ids [String] The array must contain the id of the record/records you want to update. In order to know the id of a record you can use the endpoint listEntityValues

Required

filters [ { field_name : String, operator : String, values : [String] } ] Filter the list by a set of fields, if multiple fields are specified will be and’ed between the fields. [ { "field_name": "seq_id", "operator" : "contains" "values": ["CON106633"] }, { "field_name" : "date_field", "operator" : "between", "values" : [ "2020-10-07T05:00:00.000Z", "2020-10-09T04:59:59.000Z" ] } ]

Available operators

Field Type Operators
Non Date Fields contains does not contains equals not equals starts with
Date Fields after before between

Example Request

mutation bulkDeleteEntities($entity: String!, $ids: [String]!, $filters: [Filter], $pattern: String) {
    bulkDeleteEntities(entity: $entity, ids: $ids, filters: $filters, pattern: $pattern) {
      sent_to_job
    }
}

Example Variables

{
    "entity" : "contact",
    "ids" : ["897cd2cd-1dbb-4f48-a248-5760ccf18bfa"],
    "filters" : [],
    "pattern" : ""
}

Example Response

{
    "data": {
        "bulkDeleteEntities": {
            "sent_to_job": null,
        }
    }
}

Create/Update App with Lines

Create or update a record with a line item, and/or both simultaneously.

GraphQL Parameters

Parameter GraphQL Type Description
!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

id String The id must be the UUID record id. In order to know the id of a record you can use the endpoint listEntityValues

Note: If the id is not specified, a new record will be created.

!field_values {field_name : value} The field name must be the system field name. In order to know the system name of the field you want to affect, from servis.ai as administrator navigate to:Admin Settings > App Setup > {your_app} > Form FieldsExample:{"work_email": "test@test.com", "contact_field1": "text"}
For references and choice list it’s required to use the ID of the value

Required

children {id: String, entity: !String, !field_values: {field_name: value}} The rules for child parameters are the same as the above described.

Required Values:

  • entity
  • field_values

Example Request

mutation upsertCompositeEntity($entity: String!, $id: String, $field_values: JSON!, $children:[JSON!]) {
upsertCompositeEntity(entity: $entity, id: $id, field_values:$field_values,children:$children){
entity_value {
id
seq_id
field_values
}
children {
id
field_values
}
}
}

Example Variables

{
    "entity": "quote",
     "field_values": {
       "quote_field8" : "2020-10-06",
       "quote_field9" : "2020-10-06",
       "owner_id":"dd3129cf-ff7e-4ef5-8d5b-daf027a913f1"
     },
     "children": [
          {
         "entity":"sub",
         "field_values":{
           "sub_field0" : "b630c9ed-62c8-4792-894f-745074fed29a",
           "sub_field2" : 1
         }
       } 
     ]
   }

Example Response

{
    "data": {
        "upsertCompositeEntity": {
            "entity_value": {
                "id": "d8bf6756-5eec-4f9a-8d5c-fd22837412ae",
                "field_values": {
                    "seq_id": {
                        "id": "83f8d35e-2f98-4a98-898b-ff2c5ea59178",
                        "value": "QUO102346",
                        "display_value": "QUO102346",
                        "type": "ID",
                        "metadata": null
                    },
                    "owner_id": {
                        "id": "75673de4-06b7-44a1-9311-97567daf328c",
                        "value": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                        "display_value": "Ivan Carrillo",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Ivan Carrillo",
                            "first_name": "Ivan",
                            "last_name": "Carrillo",
                            "email_address": "ivan.carrillo@freeagentsoftware.com",
                            "id": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                            "display_name": "Ivan Carrillo",
                            "deleted": false
                        }
                    },
                    "quote_field8": {
                        "id": "fa47e9e9-34f1-430a-a35d-4f306ed7a255",
                        "value": "2020-10-06",
                        "display_value": "2020-10-06",
                        "type": "Date",
                        "metadata": null
                    },
                    "quote_field9": {
                        "id": "0daf29fa-deb0-4b20-8946-ebe10811275f",
                        "value": "2020-10-06",
                        "display_value": "2020-10-06",
                        "type": "Date",
                        "metadata": null
                    }
                }
            },
            "children": [
                {
                    "id": "5b1ef68c-1429-4681-a419-7fd76e103143",
                    "field_values": {
                        "sub_field0": {
                            "id": "648dc449-6ad9-4a68-8385-dd6c2ff0be13",
                            "value": "b630c9ed-62c8-4792-894f-745074fed29a",
                            "type": "reference"
                        },
                        "sub_field2": {
                            "id": "44c1fea6-a775-41a1-99b2-8dcd1cb51ef9",
                            "value": 1,
                            "display_value": 1,
                            "type": "number"
                        }
                    }
                }
            ]
        }
    }
}

Example Request – Update Record Scenario

mutation upsertCompositeEntity($entity: String!, $id: String, $field_values: JSON!, $children:[JSON!]) {
    upsertCompositeEntity(entity: $entity, id: $id, field_values:$field_values,children:$children){
     entity_value {
       id
       seq_id
      field_values
     }
      children {
        id
        field_values
      }
    }
  }

Example Variables

{
    "entity": "quote",
    "id" : "d8bf6756-5eec-4f9a-8d5c-fd22837412ae"
     "field_values": {
       "quote_field8" : "2022-10-06",
       "quote_field9" : "2022-10-06"
     },
     "children": [
          {
         "entity":"sub",
         "field_values":{
           "sub_field0" : "b630c9ed-62c8-4792-894f-745074fed29a",
           "sub_field2" : 1
         }
       }
     ]
   }

Example Response

{
    "data": {
        "upsertCompositeEntity": {
            "entity_value": {
                "id": "d8bf6756-5eec-4f9a-8d5c-fd22837412ae",
                "field_values": {
                    "seq_id": {
                        "id": "83f8d35e-2f98-4a98-898b-ff2c5ea59178",
                        "value": "QUO102346",
                        "display_value": "QUO102346",
                        "type": "ID",
                        "metadata": null
                    },
                    "owner_id": {
                        "id": "75673de4-06b7-44a1-9311-97567daf328c",
                        "value": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                        "display_value": "Ivan Carrillo",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Ivan Carrillo",
                            "first_name": "Ivan",
                            "last_name": "Carrillo",
                            "email_address": "ivan.carrillo@freeagentsoftware.com",
                            "id": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                            "display_name": "Ivan Carrillo",
                            "deleted": false
                        }
                    },
                    "quote_field8": {
                        "id": "fa47e9e9-34f1-430a-a35d-4f306ed7a255",
                        "value": "2022-10-06",
                        "display_value": "2022-10-06",
                        "type": "Date",
                        "metadata": null
                    },
                    "quote_field9": {
                        "id": "0daf29fa-deb0-4b20-8946-ebe10811275f",
                        "value": "2022-10-06",
                        "display_value": "2022-10-06",
                        "type": "Date",
                        "metadata": null
                    }
                }
            },
            "children": [
                {
                    "id": "5b1ef68c-1429-4681-a419-7fd76e103143",
                    "field_values": {
                        "sub_field0": {
                            "id": "648dc449-6ad9-4a68-8385-dd6c2ff0be13",
                            "value": "b630c9ed-62c8-4792-894f-745074fed29a",
                            "type": "reference"
                        },
                        "sub_field2": {
                            "id": "44c1fea6-a775-41a1-99b2-8dcd1cb51ef9",
                            "value": 1,
                            "display_value": 1,
                            "type": "number"
                        }
                    }
                }
            ]
        }
    }
}

 

Create Notes

Create a note in the activity time line of any of your records.

GraphQL Parameters

Parameter GraphQL Type Description
entity String In order to know the entity object name, you can consult the object name in your Apps configuration. Required e.g “note_fa”
note_fa_field0 String Note body to post to activity, can be formatted via html.
note_fa_field1 String Id of parent entity (Source App) the activity needs to be posted on, use getEntities API to get access to entity_id.
task_mentions String Id of the parent record(Source Record) on which the activity needs to be posted to.
note_type String Id of type of note if needed, use getFieldItems API to get the UUID of the desired type

Example Request

mutation createEntity($entity: String!, $field_values: JSON!) {
createEntity(entity: $entity, field_values: $field_values) {
entity_value {
id
seq_id
field_values
}
}
}

Example Variables

{
"entity": "note_fa",
"field_values": {
"note_fa_field0": "<div>Test Note goes here</div>",
"note_fa_field1": "ac12096d-027b-57f5-b389-93c1920222a3",
"note_fa_field2": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
"note_type": "d5ba68aa-4252-4f47-a66e-64713b2f75b1",
}
}

Example Response

{
    "data": {
        "createEntity": {
            "entity_value": {
                "id": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                "seq_id": "NOT120726",
                "field_values": {
                    "seq_id": {
                        "id": "3901d627-5f22-420f-aef6-9a5f7543b64e",
                        "value": "NOT120726",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "NOT120726",
                        "formatted_value": "NOT120726",
                        "type": "ID",
                        "metadata": null
                    },
                    "note_fa_field0": {
                        "id": "3d282a8c-92c2-45d3-aabd-ca0b3c79e3ee",
                        "value": "<div>Test Note goes here 2</div>",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "Test Note goes here",
                        "formatted_value": "Test Note goes here",
                        "type": "rich_text",
                        "metadata": null
                    },
                    "note_fa_field1": {
                        "id": "9a8c6d13-96a4-4102-9757-117243408bad",
                        "value": "ac12096d-027b-57f5-b389-93c1920222a3",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "Contact",
                        "formatted_value": "Contact",
                        "type": "reference",
                        "metadata": {
                            "subtitles": [
                                {"field": {"text": "Contact Type", "type": "reference", "label": "Contact Type", "value": "contact_field1" }},
                                {"field": {"text": "Contact Owner", "type": "reference", "label": "Contact Owner", "value": "lead_owner_id" }},
                                {"field": {"text": "Speed to Lead", "type": "duration", "label": "Speed to Lead", "value": "virtual--speed_to_lead" }},
                                {"field": {"text": "First Outreach", "type": "datetimecomplete", "label": "First Outreach", "value": "virtual--first_outreach" }}
                            ],
                            "default_sorts": [[ "seq_id", "desc"]],
                            "unique_fields": ["94a10986-b767-4b35-842d-599e9f775551"],
                            "form_layout_style": "792107e7-a652-4d89-9e1a-f23ffd44b269",
                            "enable_speed_to_lead": true,
                            "enable_approval_rules": false,
                            "set_sections_as_pages": null,
                            "quick_add_smart_fields": [],
                            "enable_assignment_rules": false,
                            "negative_stage_changes_list": [
                                null
                            ],
                            "positive_stage_changes_list": [
                                null
                            ]
                        }
                    },
                    "note_fa_field2": {
                        "id": "5b2f36ff-1962-4f0d-b3c4-7d96857f68ad",
                        "value": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "Sharan Murali",
                        "formatted_value": "Sharan Murali",
                        "type": "reference"
                    },
                    "created_at": {
                        "id": "7b2ef3fb-7fde-427a-9d8a-b64829d4bbcd",
                        "value": "2024-12-05T06:24:58.812Z",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "2024-12-05T06:24:58.812Z",
                        "formatted_value": "2024-12-05T06:24:58.812Z",
                        "type": "DateTimeComplete",
                        "metadata": null
                    },
                    "updated_at": {
                        "id": "54e63e0c-6b90-447b-baad-c887237537f7",
                        "value": "2024-12-05T06:24:58.812Z",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "2024-12-05T06:24:58.812Z",
                        "formatted_value": "2024-12-05T06:24:58.812Z",
                        "type": "DateTimeComplete",
                        "metadata": null
                    },
                    "created_by": {
                        "id": "717db41e-5f2e-4e2d-a258-88f4bbcdb7fa",
                        "value": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "Sharan Murali",
                        "formatted_value": "Sharan Murali",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Sharan Murali",
                            "first_name": "Sharan",
                            "last_name": "Murali",
                            "portrait_url": "https://freeagent-network-public.s3.us-west-2.amazonaws.com/d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d/1687515142455",
                            "email_address": "mbastida1992@gmail.com",
                            "extra_info": true,
                            "id": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                            "display_name": "Sharan Murali",
                            "deleted": false
                        }
                    },
                    "updated_by": {
                        "id": "011c27d6-f1c6-466c-bbe0-a00997760918",
                        "value": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "display_value": "Sharan Murali",
                        "formatted_value": "Sharan Murali",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Sharan Murali",
                            "first_name": "Sharan",
                            "last_name": "Murali",
                            "portrait_url": "https://freeagent-network-public.s3.us-west-2.amazonaws.com/d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d/1687515142455",
                            "email_address": "mbastida1992@gmail.com",
                            "extra_info": true,
                            "id": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                            "display_name": "Sharan Murali",
                            "deleted": false
                        }
                    },
                    "note_type": {
                        "id": "21a11cc1-a416-4699-8761-4ad2e7d6494f",
                        "instanceId": "7740cf43-48a6-4ad9-9bb3-e3e120911e39",
                        "type": "reference",
                        "metadata": null
                    }
                }
            }
        }
    }
}

Create Task

Create a Task in the activity time line of any of your records.

GraphQL Parameters

Parameter GraphQL Type Description
entity String In order to know the entity object name, you can consult the object name in your Apps configuration. Required e.g “task
description String Task Title
fa_entity_id String Id of parent entity (Source App) the activity needs to be posted on, use getEntities API to get access to entity_id.
fa_entity_reference_id String Id of the parent record(Source Record) on which the activity needs to be posted to.
task_type String Id of type of task if needed, use getFieldItems API to get the UUID of the desired type
due_date Date The format can be YYYY-MM-DD or ISO Date YYYY-MM-DD:HH:MM:SS.000z
assigned_to String The id must be the UUID of the user to whom the task needs to be assigned to. In order to know the id of a user you can use the endpoint getTeamMembers
note   Note body for the Task to post to activity, can be formatted via html.

Example Request

mutation createEntity($entity: String!, $field_values: JSON!) {
  createEntity(entity: $entity, field_values: $field_values) {
    entity_value {
      id
      seq_id
      field_values
    }
  }
}

Example Variables

{
  "entity": "task",
  "field_values": {
    "fa_entity_id": "5e5ed92e-46a1-4a7d-bd53-f45956758ccd",
    "fa_entity_reference_id": "21550c26-243d-4183-8b2f-55ffe04a9528",
    "task_type": "280e8dcf-e9f3-44dd-97ca-8dab2711d509",
    "description": "Sample Task Title",
    "due_date": "2024-12-06T11:30:00.000Z",
    "due_date_reminder": "52331445-4e49-4e98-9a19-a3776b9156ab",
    "task_status": false,
    "assigned_to": "f8d7bf51-5b3e-431c-bd62-4702d0d934ab",
    "note": "Notes for the Task"
  }
}

Example Response

[
  {
    "data": {
      "createEntity": {
        "entity_value": {
          "id": "9a785c60-0606-489a-a392-465577099a25",
          "seq_id": "TAS115488",
          "field_values": {
            "created_at": {
              "id": "718d0237-4051-4574-a821-fffd88a61128",
              "value": "2024-12-05T07:12:47.650Z",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "2024-12-05T07:12:47.650Z",
              "formatted_value": "Thursday, December 5th 2024, 12:42:47 pm",
              "type": "DateTimeComplete",
              "metadata": null
            },
            "description": {
              "id": "0b1db3f2-ea8e-40eb-88e7-31650c5f7e8a",
              "value": "Sample Task Title",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Sample Task Title",
              "formatted_value": "Sample Task Title",
              "type": "text",
              "metadata": null
            },
            "task_type": {
              "id": "4c739a7b-b99f-4546-99af-8ab25eb41865",
              "value": "280e8dcf-e9f3-44dd-97ca-8dab2711d509",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Todo",
              "formatted_value": "Todo",
              "user_defined_value": "todo",
              "type": "reference",
              "metadata": {"custom_fields": {"icon": "fac5b80f-932a-4214-8de5-1ba77b30cd22","color": "#ff9800"},
                "user_defined_value": "todo",
                "extra_info": true,
                "id": "280e8dcf-e9f3-44dd-97ca-8dab2711d509",
                "display_name": "Todo",
                "deleted": false,
                "catalog_type.id": "9eca0e0e-1b76-40f3-874f-f268b5d9548e",
                "catalog_type.name": "Task Type - Task",
                "catalog_type.deleted": false,
                "catalog_type.metadata": null
              }
            },
            "updated_at": {
              "id": "33e45dcb-68a8-4a41-9da0-ef7015805370",
              "value": "2024-12-05T07:12:47.650Z",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "2024-12-05T07:12:47.650Z",
              "formatted_value": "Thursday, December 5th 2024, 12:42:47 pm",
              "type": "DateTimeComplete",
              "metadata": null
            },
            "note": {
              "id": "ca07a66f-22dc-4f79-ab6d-384a945647dc",
              "value": "Notes for the Task",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Notes for the Task",
              "formatted_value": "Notes for the Task",
              "type": "rich_text",
              "metadata": null
            },
            "created_by": {
              "id": "96e9d2e4-1093-404c-ae34-4ceaaa4e1b8f",
              "value": "f8d7bf51-5b3e-431c-bd62-4702d0d934ab",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Sharan Murali",
              "formatted_value": "Sharan Murali",
              "type": "reference",
            },
            "task_status": {
              "id": "4270c048-b977-46fc-9cb3-b5845998abc6",
              "value": false,
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": false,
              "formatted_value": false,
              "type": "boolean",
              "metadata": null
            },
            "fa_entity_id": {
              "id": "5935970e-3202-4040-ba48-57fcefe5c7a2",
              "value": "5e5ed92e-46a1-4a7d-bd53-f45956758ccd",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Contact",
              "formatted_value": "Contact",
              "type": "reference"
              }
            },
            "updated_by": {
              "id": "66d95b18-95e5-4940-b960-247f8ccac5fe",
              "value": "f8d7bf51-5b3e-431c-bd62-4702d0d934ab",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "QA Clone 7",
              "formatted_value": "QA Clone 7",
              "type": "reference"
            },
            "created_by_job": {
              "id": "68f03d2a-0b94-42b2-8dde-6007f24d4214",
              "value": null,
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": null,
              "formatted_value": null,
              "type": "bot_job_info",
              "metadata": null
            },
            "fa_entity_reference_id": {
              "id": "77d91f80-5163-4a8c-b80d-40ab66bd4d0a",
              "value": "21550c26-243d-4183-8b2f-55ffe04a9528",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Fax Contact",
              "formatted_value": "Fax Contact",
              "type": "reference"
            },
            "due_date": {
              "id": "eef77ca3-f27c-4690-b0cc-6e368423d338",
              "value": "2024-12-06T11:30:00.000Z",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "2024-12-06T11:30:00.000Z",
              "formatted_value": "Friday, December 6th 2024, 5:00:00 pm",
              "type": "DateTimeComplete",
              "metadata": null
            },
            "updated_by_job": {
              "id": "6c25c56b-a7be-4d2d-9a7e-7e83548a4899",
              "value": null,
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": null,
              "formatted_value": null,
              "type": "bot_job_info",
              "metadata": null
            },
            "assigned_to": {
              "id": "9e90ef2f-a6e4-402c-b9a6-e874346bd876",
              "value": "f8d7bf51-5b3e-431c-bd62-4702d0d934ab",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "Sharan Murali",
              "formatted_value": "Sharan Murali",
              "type": "reference",
              "metadata": {
                "full_name": "Sharan Murali",
                "first_name": "Sharan",
                "last_name": "Murali",
                "email_address": "sharan+8dec@gmail.com",
                "extra_info": true,
                "id": "f8d7bf51-5b3e-431c-bd62-4702d0d934ab",
                "display_name": "Sharan Murali",
                "deleted": false
              }
            },
            "seq_id": {
              "id": "1005da52-8402-4370-8bf4-400e01be9b7e",
              "value": "TAS115488",
              "instanceId": "9a785c60-0606-489a-a392-465577099a25",
              "display_value": "TAS115488",
              "formatted_value": "TAS115488",
              "type": "ID",
              "metadata": null
            },
          }
        }
      }
    }
  }
]

 

Connect Postman to Servis.ai

Directly execute queries using the REST client Postman. To interact with GraphQL API, use the Postman Collection. The Postman Collection comes with a configurable environment and variables that let you easily authenticate.

 

Install Postman

Before you can connect Postman to Servis.ai, fork/import and configure the collection. See the installation instructions.

Sign Up for Postman and Create a Workspace

Postman has two options for working with its app: desktop and web. You use the web browser app for this project.

  1. Sign in to your Postman account or sign up for an account.
  2. Select the Workspaces menu.
  3. Select Create Workspace.
  4. Name your workspace ServisCollection.
  5. Set Visibility to Personal.
  6. Click Create Workspace button.

Import Servis.ai API Collection

  1. Download the Servis.ai API Collection file by clicking here.
  2. Open Postman and navigate to the Collections tab on the left-hand side. Click on the “Import” button located in the top-left corner of the screen.
  3. In the “Import File” modal, click on the “Choose Files” button and select the Postman collection file you need to import. Or you can pass the URL of the file
  4. Once the file has been selected, click on the “Import” button to initiate the import process.
  5. After the import process is complete, you should see your newly imported Servis.ai API collection listed in the Collections tab.

You now have the collection ready in Postman. Let’s use the collection to authorize your org and test it.

Authorize Your Org

You need to authenticate with Servis.ai to access the APIs. Authentication grants you an access token that’s valid for a certain duration. Repeat this process whenever your access token expires.

  1. In Postman, under Collections, Servis.ai APIs should be selected.
  2. Be sure No Environment is selected.
  3. Open the Variable tab
  4. In the client_id row, CURRENT VALUE column, paste the Client ID value that you get here.
  5. In the client_secret row, CURRENT VALUE column, paste the Client Secret value that you get here.
  6. The Authorization tab should be open.
  7. Type should be OAuth 2.0.
  8. Click Get New Access Token.
  9. A success message appears briefly, and then you’re redirected to the Manage Access Tokens dialog.
    Screenshot_2024-12-06_at_10.10.00_PM.png
  10. Verify that a new access token is generated
  11. Click Use Token.

A Quick Connection Test

Let’s verify that the connection is working.

  1. In Collections, select Servis.ai APIs to expand it.
  2. Select Queries to expand it.
  3. Select List Account Users.It opens in the main panel.
  4. Click Send.
    Screenshot_2024-12-06_at_10.05.53_PM.png
  5. Verify that the status is 200 OK.

Excellent! You’ve successfully authenticated with Servis.ai. Now you can use other requests in the collection. The Servis.ai APIs for Postman collection that you loaded will aid you in your quest to discover the Servis.ai APIs.

🙄

😐

😊

😍

Welcome to servis.ai Free Edition

Link your email to begin

Continue with Google

Continue with Microsoft

By continuing, you agree to servis.ai Terms of Use. Read our Privacy Policy.

Get Started with servis.ai

30-minute demo where you see servis.ai in action.

Unlock the essential servis.ai features at no cost.

How can I be of servis?
How can I be of servis?