NAV Navbar
  • Get started
  • CSAT
  • CES
  • NPS
  • Customers
  • Surveys
  • Teams
  • Users
  • Get started

    Older API

    If you are looking for our older API, please follow this link.

    Authentication

    Nicereply uses Basic HTTP Authentication to allow access to the API. You can leave username blank, and use private key as a password.

    API expects for the API key to be included in all API requests to the server.

    Request format

    We recommend you to put Accept header which should contain application/json value because this is the only format we are supporting now.
    And we also recommend you for each POST and PATCH request put Content-Type header with application/json value because we are receiving data in JSON format from your applications.

    Accept: application/json
    Content-Type: application/json

    Pagination

    {
      "_results": [
        // ...
      ],
      "_pagination": {
        "total": 62,
        "count": 10,
        "per_page": 10,
        "current_page": 2,
        "total_pages": 7,
        "links": {
          "next": "/v1/endpoint?page=3",
          "previous": "/v1/endpoint?page=1"
        }
      }
    }
    

    Pagination is available in every endpoint which return collection of the resources. Information about pagination is in _pagination field with this subfields:

    Field Type Description
    total integer Count of all resources
    count integer Count of resources in current page
    per_page integer Limit how many resources can be in one page
    current_page integer Current page
    total_pages integer Total pages
    links object Paths to next & previous page
    Field Type Description
    next string (optional) Path to next page. When there is no next page, field is not presented.
    previous string (optional) Path to previous page. When there is no previous page, field is not presented.

    Pagination query parameters

    Field Type Default Description
    page integer (optional) 1 Requested page
    per_page integer (optional) 10 How many recources will be in response per page. (10 - 100).

    Date format

    In all API endpoints (in responses and in query parameters) we use date/time format ISO 8601.

    These three formats are valid on our side:
    2017-10-24T13:37:00+02:00
    2017-10-24T13:37:00-02:00
    2017-10-24T13:37:00Z

    Errors

    {
      "errors": [
        "Validation error in queryParameters[per_page]: This value should be 100 or less.",
        "Validation error in queryParameters[page]: This value should be a valid number.",
        "Validation error in requestBody[survey_id]: This field is missing."
      ]
    }
    

    When occurs an error, there will be response with errors field as array that contains all errors with corresponding HTTP status code.

    HTTP Status Code Description
    400 Bad Request Validation error, wrong JSON syntax, ...
    401 Unauthorized Wrong or missing basic authentication.
    402 Payment Required Trial ended or service wasn't paid.
    404 Not Found Resource or route cannot be found.
    429 Too Many Requests When rate limits was hitted (currently no limits).

    CSAT

    CSAT Rating model fields

    Field Type Nullable Description
    id integer No
    score string No Min: 1, Max: 10
    from string No
    ip_address integer No IPv4 format
    comment string Yes
    created_at string No ISO8601 date
    updated_at string No ISO8601 date
    survey object No
    user object No
    customer object Yes
    ticket object Yes
    extra_questions array Yes Array of extra_question objects

    survey object fields

    Field Type Nullable Description
    id integer No
    metric string(enum) No Valid values: CSAT

    user object fields

    Field Type Nullable Description
    id integer No
    username string No

    customer object fields

    Field Type Nullable Description
    id integer No

    ticket object fields

    Field Type Nullable Description
    value string No
    link string Yes Direct URL to the ticket (only if the integration supports this feature).

    extra_question object fields

    Field Type Nullable Description
    id integer No
    score integer No

    Get all CSAT ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": {
            "value": "cnv_2841049",
            "link": null
          },
          "survey": {
            "id": 1,
            "type": "CSAT"
          },
          "customer": {
            "id": 33
          },
          "user": {
            "id": 58,
            "username": "mr-unclebob"
          },
          "extra_questions": [
            {
              "id": 1,
              "score": 1
            }
          ],
          "_links": {
            "self": "/v1/csat/ratings/1",
            "survey": "/v1/surveys/1",
            "user": "/v1/users/58",
            "customer": "/v1/customers/33"
          }
        }
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to CSAT metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/csat/ratings

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get CSAT rating

    Response 200 OK

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": {
          "value": "cnv_2841049",
          "link": null
        },
        "survey": {
          "id": 1,
          "type": "CSAT"
        },
        "customer": {
          "id": 33
        },
        "user": {
          "id": 58,
          "username": "mr-unclebob"
        },
        "extra_questions": [
          {
            "id": 1,
            "score": 1
          }
        ],
        "_links": {
          "self": "/v1/csat/ratings/1",
          "survey": "/v1/surveys/1",
          "user": "/v1/users/58",
          "customer": "/v1/customers/33"
        }
      }
    }
    

    This endpoint retrieves a specific CSAT rating.

    HTTP Request

    GET https://api.nicereply.com/v1/csat/ratings/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the CSAT rating to retrieve

    Get CSAT stats

    Response 200 OK

    {
      "_results": {
        "average": 0,
        "count": 0
      }
    }
    

    This endpoint retrieves CSAT metric stats.

    HTTP Request

    GET https://api.nicereply.com/v1/csat/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get CSAT histogram

    Response 200 OK

    {
      "_results": {
        "histogram": {
          "1": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0,
          "10": 0
        }
      }
    }
    

    This endpoint retrieves metric histogram for CSAT metric.

    HTTP Request

    GET https://api.nicereply.com/v1/csat/histogram

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get CSAT surveys

    Response 200 OK

    {
      "_results": [
        {
          "id": 48,
          "name": "Helpdesk Survey",
          "metric": "CSAT",
          "distribution": "trigger",
          "rating_scale": "faces",
          "question": "How nice was my reply?",
          "extra_questions": [
            {
              "id": 1,
              "label": "Some extra question is the survey",
              "rating_scale": "thumbs",
              "required": true
            }
          ],
          "_links": {
            "self": "/v1/surveys/48"
          }
        }
      ],
      "_pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all surveys which belongs to CSAT metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/csat/surveys

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Create CSAT new rating

    Response 201 Created

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": null,
        "survey": {
          "id": 1,
          "type": "CSAT"
        },
        "customer": null,
        "user": null
      }
    }
    

    This endpoint creates new rating and return it to the response with HTTP status 201 Created.

    HTTP Request

    POST https://api.nicereply.com/v1/csat/ratings

    BODY Parameters

    Parameter Required Nullable Type Description
    survey_id Yes No integer CSAT Survey ID
    score Yes No integer Min: 1, Max: 10; it depends on rating scale of survey.
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)
    extra_questions No* No array Array of extra_question objects.

    extra_question object parameters

    Parameter Required Nullable Type Description
    id Yes No integer Extra question ID
    score Yes Yes* integer Min: 1, Max: 10;
    Cannot be nullable and must be provided when extra question is marked as required.

    Update CSAT rating

    Response 204 No Content

    This endpoint updates rating and return empty response with HTTP status 204 No Content.

    HTTP Request

    PATCH https://api.nicereply.com/v1/csat/ratings/<ID>

    BODY Parameters

    Parameter Required Nullable Type Description
    score Yes No integer Min: 1, Max: 10; Depends on the rating scale of the survey.
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)
    extra_questions No* No array Array of extra_question objects.

    extra_question object parameters

    Parameter Required Nullable Type Description
    id Yes No integer Extra question ID
    score Yes Yes* integer Min: 1, Max: 10;
    Depends on the rating scale of the extra question

    Cannot be nullable and must be provided when extra question is marked as required.

    CES

    CES Rating model fields

    Field Type Nullable Description
    id integer No
    score string No Min: 1, Max: 7
    from string No
    ip_address integer No IPv4 format
    comment string Yes
    created_at string No ISO8601 date
    updated_at string No ISO8601 date
    survey object No
    user object No
    customer object Yes
    ticket object Yes

    survey object fields

    Field Type Nullable Description
    id integer No
    metric string(enum) No Valid values: CES

    user object fields

    Field Type Nullable Description
    id integer No
    username string No

    customer object fields

    Field Type Nullable Description
    id integer No

    ticket object fields

    Field Type Nullable Description
    value string No
    link string Yes Direct URL to the ticket (only if the integration supports this feature).

    Get all CES ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": {
            "value": "cnv_2841049",
            "link": null
          },
          "survey": {
            "id": 1,
            "type": "CES"
          },
          "customer": {
            "id": 33
          },
          "user": {
            "id": 58,
            "username": "mr-unclebob"
          },
          "_links": {
            "self": "/v1/ces/ratings/1",
            "survey": "/v1/surveys/1",
            "user": "/v1/users/58",
            "customer": "/v1/customers/33"
          }
        }
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to CES metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/ces/ratings

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get CES rating

    Response 200 OK

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": {
          "value": "cnv_2841049",
          "link": null
        },
        "survey": {
          "id": 1,
          "type": "CES"
        },
        "customer": {
          "id": 33
        },
        "user": {
          "id": 58,
          "username": "mr-unclebob"
        },
        "_links": {
          "self": "/v1/ces/ratings/1",
          "survey": "/v1/surveys/1",
          "user": "/v1/users/58",
          "customer": "/v1/customers/33"
        }
      }
    }
    

    This endpoint retrieves a specific CES rating.

    HTTP Request

    GET https://api.nicereply.com/v1/ces/ratings/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the CES rating to retrieve

    Get CES stats

    Response 200 OK

    {
      "_results": {
        "average": 0,
        "count": 0
      }
    }
    

    This endpoint retrieves CES metric stats.

    HTTP Request

    GET https://api.nicereply.com/v1/ces/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get CES histogram

    Response 200 OK

    {
      "_results": {
        "histogram": {
          "1": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0
        }
      }
    }
    

    This endpoint retrieves metric histogram for CES metric.

    HTTP Request

    GET https://api.nicereply.com/v1/ces/histogram

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get CES surveys

    Response 200 OK

    {
      "_results": [
        {
          "id": 38,
          "name": "CES Survey",
          "metric": "CES",
          "distribution": "template",
          "question": "Nicereply made it easy for me to handle my issue.",
          "_links": {
            "self": "/v1/surveys/38"
          }
        }
      ],
      "_pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all surveys which belongs to CES metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/ces/surveys

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Create new CES rating

    Response 201 Created

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": null,
        "survey": {
          "id": 1,
          "type": "CES"
        },
        "customer": null,
        "user": null
      }
    }
    

    This endpoint creates new rating and return it to the response with HTTP status 201 Created.

    HTTP Request

    POST https://api.nicereply.com/v1/ces/ratings

    BODY Parameters

    Parameter Required Nullable Type Description
    survey_id Yes No integer CES Survey ID
    score Yes No integer Min: 1, Max: 7
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)

    Update CES rating

    Response 204 No Content

    This endpoint updates rating and return empty response with HTTP status 204 No Content.

    HTTP Request

    PATCH https://api.nicereply.com/v1/ces/ratings/<ID>

    BODY Parameters

    Parameter Required Nullable Type Description
    score Yes No integer Min: 1, Max: 7
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)

    NPS

    NPS Rating model fields

    Field Type Nullable Description
    id integer No
    score string No Min: 0, Max: 10
    from string No
    ip_address integer No IPv4 format
    comment string Yes
    created_at string No ISO8601 date
    updated_at string No ISO8601 date
    survey object No
    user object No
    customer object Yes
    ticket object Yes

    survey object fields

    Field Type Nullable Description
    id integer No
    metric string(enum) No Valid values: NPS

    user object fields

    Field Type Nullable Description
    id integer No
    username string No

    customer object fields

    Field Type Nullable Description
    id integer No

    ticket object fields

    Field Type Nullable Description
    value string No
    link string Yes Direct URL to the ticket (only if the integration supports this feature).

    Get all NPS ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": {
            "value": "cnv_2841049",
            "link": null
          },
          "survey": {
            "id": 1,
            "type": "NPS"
          },
          "customer": {
            "id": 33
          },
          "user": {
            "id": 58,
            "username": "mr-unclebob"
          },
          "_links": {
            "self": "/v1/nps/ratings/1",
            "survey": "/v1/surveys/1",
            "user": "/v1/users/58",
            "customer": "/v1/customers/33"
          }
        }
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to NPS metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/nps/ratings

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get NPS rating

    Response 200 OK

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": {
          "value": "cnv_2841049",
          "link": null
        },
        "survey": {
          "id": 1,
          "type": "NPS"
        },
        "customer": {
          "id": 33
        },
        "user": {
          "id": 58,
          "username": "mr-unclebob"
        },
        "_links": {
          "self": "/v1/nps/ratings/1",
          "survey": "/v1/surveys/1",
          "user": "/v1/users/58",
          "customer": "/v1/customers/33"
        }
      },
    }
    

    This endpoint retrieves a specific NPS rating.

    HTTP Request

    GET https://api.nicereply.com/v1/nps/ratings

    URL Parameters

    Parameter Type Description
    ID integer The ID of the NPS rating to retrieve

    Get NPS stats

    Response 200 OK

    {
      "_results": {
        "nps_score": 0,
        "count": 0,
        "groups": {
          "promoters": 0,
          "passives": 0,
          "detractors": 0
        }
      }
    }
    

    This endpoint retrieves NPS metric stats.

    HTTP Request

    GET https://api.nicereply.com/v1/nps/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get NPS histogram

    Response 200 OK

    {
      "_results": {
        "histogram": {
          "0": 0,
          "1": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0,
          "10": 0
        }
      }
    }
    

    This endpoint retrieves metric histogram for NPS metric.

    HTTP Request

    GET https://api.nicereply.com/v1/nps/histogram

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get NPS surveys

    Response 200 OK

    {
      "_results": [
        {
          "id": 21,
          "name": "Customer Feedback Survey",
          "metric": "NPS",
          "distribution": "template",
          "question": "How likely is it that you would recommend Nicereply to a friend or colleague?",
          "_links": {
            "self": "/v1/surveys/21"
          }
        }
      ],
      "_pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all surveys which belongs to NPS metric.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/nps/surveys

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Create new NPS rating

    Response 201 Created

    {
      "_results": {
        "id": 1,
        "score": 5,
        "from": "Viktor Magic",
        "ip_address": "8.8.8.8",
        "comment": "Nice reply! :)",
        "created_at": "2017-10-24T13:37:01+02:00",
        "updated_at": "2017-10-24T13:37:01+02:00",
        "ticket": null,
        "survey": {
          "id": 1,
          "type": "NPS"
        },
        "customer": null,
        "user": null
      }
    }
    

    This endpoint creates new rating and return it to the response with HTTP status 201 Created.

    HTTP Request

    POST https://api.nicereply.com/v1/nps/ratings

    BODY Parameters

    Parameter Required Nullable Type Description
    survey_id Yes No integer NPS Survey ID
    score Yes No integer Min: 0, Max: 10
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)

    Update NPS rating

    Response 204 No Content

    This endpoint updates rating and return empty response with HTTP status 204 No Content.

    HTTP Request

    PATCH https://api.nicereply.com/v1/nps/ratings/<ID>

    BODY Parameters

    Parameter Required Nullable Type Description
    score Yes No integer Min: 0, Max: 10
    from No* No string From is required when Name field is enabled is the survey.
    comment No No string Rating comment
    ticket No Yes string Ticket Number
    user No Yes object Object must contain only one of the following fields:
    id (integer) OR
    username (string).
    customer_id No Yes integer Customer ID
    ip_address No No string IP address of the rating (currently is only IPv4 supported)

    Customers

    Customer model fields

    Field Type Nullable Description
    id integer No
    name string No
    email string No
    tickets integer No
    created_at string No ISO8601 date
    updated_at string No ISO8601 date

    Get all customers

    Response 200 OK

    {
      "_results": [
        {
          "id": 32,
          "name": "Freddy Coleman",
          "email": "freddy-coleman@example.com",
          "tickets": 4,
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/customers/32"
          }
        },
        {
          "id": 16,
          "name": "Robert C. Martin",
          "email": "unclebob@example.com",
          "tickets": 38,
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/customers/16"
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your customers.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/customers

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Get stats for all customers

    Response 200 OK

    {
      "_results": [
        {
          "id": 32,
          "stats": {
            "CSAT": {
              "average": 6.4444,
              "count": 153
            },
            "CES": {
              "average": 5,
              "count": 133
            },
            "NPS": {
              "nps_score": -71,
              "count": 17,
              "groups": {
                "promoters": 2,
                "passives": 1,
                "detractors": 14
              }
            }
          }
        },
        {
          "id": 16,
          "stats": {
            "CSAT": {
              "average": 0,
              "count": 0
            },
            "CES": {
              "average": 0,
              "count": 0
            },
            "NPS": {
              "nps_score": 0,
              "count": 0,
              "groups": {
                "promoters": 0,
                "passives": 0,
                "detractors": 0
              }
            }
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your customers with stats to all metrics.

    HTTP Request

    GET https://api.nicereply.com/v1/customers/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a customer

    Response 200 OK

    {
      "id": 32,
      "name": "Freddy Coleman",
      "email": "freddy-coleman@example.com",
      "tickets": 4,
      "created_at": "2017-10-24T13:37:01+02:00",
      "updated_at": "2017-10-24T13:37:01+02:00",
      "_links": {
        "self": "/v1/customers/32"
      }
    }
    

    This endpoint retrieves a specific customer.

    HTTP Request

    GET https://api.nicereply.com/v1/customers/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the customer to retrieve

    Get a customer ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 432,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": {
            "value": "19867463",
            "link": null
          },
    
          ...
        },
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to the customer.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/customers/<ID>/ratings

    URL Parameters

    Parameter Type Description
    ID integer The ID of the customer to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a customer stats

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "average": 6.4444,
          "count": 153
        },
        "CES": {
          "average": 5,
          "count": 133
        },
        "NPS": {
          "nps_score": -71,
          "count": 17,
          "groups": {
            "promoters": 2,
            "passives": 1,
            "detractors": 14
          }
        }
      }
    }
    

    This endpoint retrieves customer stats for all metrics.

    HTTP Request

    GET https://api.nicereply.com/v1/customers/<ID>/stats

    URL Parameters

    Parameter Type Description
    ID integer The ID of the customer to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a customer histogram

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "histogram": {
            "1": 3,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 99,
            "6": 0,
            "7": 0,
            "8": 11,
            "9": 0,
            "10": 40
          }
        },
        "CES": {
          "histogram": {
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 133,
            "6": 0,
            "7": 0
          }
        },
        "NPS": {
          "histogram": {
            "0": 0,
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 14,
            "6": 0,
            "7": 1,
            "8": 0,
            "9": 2,
            "10": 0
          }
        }
      }
    }
    

    This endpoint retrieves customer histogram for all metrics.

    HTTP Request

    GET https://api.nicereply.com/v1/customers/<ID>/histogram

    URL Parameters

    Parameter Type Description
    ID integer The ID of the customer to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Surveys

    Survey model fields

    Field Type Description
    id integer
    name string
    metric string(enum) Valid values: CSAT, CES or NPS
    distribution string(enum) Valid values: template, trigger or campaign
    rating_scale string(enum) Provided only when metric is CSAT!
    Valid values: faces, stars or thumbs
    question string
    extra_questions array Provided only when metric is CSAT!

    extra_question object parameters (only for CSAT metric)

    Parameter Type Description
    id integer Extra question ID.
    label string
    rating_scale string(enum) Valid values: faces, stars or thumbs
    required boolean

    Get all surveys

    Response 200 OK

    {
      "_results": [
        {
          "id": 48,
          "name": "Helpdesk Survey",
          "metric": "CSAT",
          "distribution": "trigger",
          "rating_scale": "faces",
          "question": "How nice was my reply?",
          "extra_questions": [
            {
              "id": 1,
              "label": "Some extra question is the survey",
              "rating_scale": "thumbs",
              "required": true
            }
          ],
          "_links": {
            "self": "/v1/surveys/48"
          }
        },
        {
          "id": 38,
          "name": "CES Survey",
          "metric": "CES",
          "distribution": "template",
          "question": "Nicereply made it easy for me to handle my issue.",
          "_links": {
            "self": "/v1/surveys/38"
          }
        },
        {
          "id": 21,
          "name": "Customer Feedback Survey",
          "metric": "NPS",
          "distribution": "template",
          "question": "How likely is it that you would recommend Nicereply to a friend or colleague?",
          "_links": {
            "self": "/v1/surveys/21"
          }
        }
      ],
      "_pagination": {
        "total": 3,
        "count": 3,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your surveys.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Get stats for all surveys

    Response 200 OK

    {
      "_results": [
        {
          "id": 48,
          "type": "CSAT",
          "stats": {
            "average": 0,
            "count": 0
          }
        },
        {
          "id": 38,
          "type": "CES",
          "stats": {
            "average": 0,
            "count": 0
          }
        },
        {
          "id": 21,
          "type": "NPS",
          "stats": {
            "nps_score": 0,
            "count": 0,
            "groups": {
              "promoters": 0,
              "passives": 0,
              "detractors": 0
            }
          }
        }
      ],
      "_pagination": {
        "total": 3,
        "count": 3,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your surveys with stats.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a survey

    Response 200 OK

    {
      "_results": {
        "id": 38,
        "name": "CES Survey",
        "metric": "CES",
        "distribution": "template",
        "question": "Nicereply made it easy for me to handle my issue.",
        "_links": {
          "self": "/v1/surveys/38"
        }
      }
    }
    

    This endpoint retrieves a specific survey.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the survey to retrieve

    Get a survey ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": null,
          "survey": {
            "id": 1,
            "type": "CSAT"
          },
          "customer": null,
          "user": null,
    
          ...
        },
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to the survey.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys/<ID>/ratings

    URL Parameters

    Parameter Type Description
    ID integer The ID of the survey to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a survey stats

    Response 200 OK

    {
      "_results": {
        "average": 0,
        "count": 0
      }
    }
    

    OR

    {
      "_results": {
        "nps_score": 0,
        "count": 0,
        "groups": {
          "promoters": 0,
          "passives": 0,
          "detractors": 0
        }
      }
    }
    

    This endpoint retrieves survey stats by metric type of survey.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys/<ID>/stats

    URL Parameters

    Parameter Type Description
    ID integer The ID of the survey to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a survey histogram

    Response 200 OK

    {
      "_results": {
        "histogram": {
          "1": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0,
          "10": 0
        }
      }
    }
    

    This endpoint retrieves survey histogram for all metric types.

    HTTP Request

    GET https://api.nicereply.com/v1/surveys/<ID>/histogram

    URL Parameters

    Parameter Type Description
    ID integer The ID of the survey to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Teams

    Team model fields

    Field Type Description
    id integer
    name string
    created_at string ISO8601 date

    Get all teams

    Response 200 OK

    {
      "_results": [
        {
          "id": 4,
          "name": "Team #2",
          "created_at": "2017-09-28T13:11:16+02:00",
          "_links": {
            "self": "/v1/teams/4"
          }
        },
        {
          "id": 2,
          "name": "Team #1",
          "created_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/teams/2"
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your teams.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/teams

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Get stats for all teams

    Response 200 OK

    {
      "_results": [
        {
          "id": 82,
          "stats": {
            "CSAT": {
              "average": 0,
              "count": 0
            },
            "CES": {
              "average": 0,
              "count": 0
            },
            "NPS": {
              "nps_score": 0,
              "count": 0
            }
          }
        },
        {
          "id": 56,
          "stats": {
            "CSAT": {
              "average": 0,
              "count": 0
            },
            "CES": {
              "average": 0,
              "count": 0
            },
            "NPS": {
              "nps_score": 0,
              "count": 0
            }
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your teams with stats.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/stats

    Query Parameters

    Parameter Default Description
    period_start none Period start.
    period_end none Period end.

    Get users for all teams

    Response 200 OK

    {
      "_results": [
        {
          "id": 4,
          "users": [
            {
              "id": 98,
              "username": "agentBob",
              "integration_usernames": [],
              "fullname": "Uncle Bob",
              "email": "unclebob@example.com",
              "role": "admin",
              "created_at": "2017-10-24T13:37:01+02:00",
              "_links": {
                "self": "/v1/users/98"
              }
            }
          ]
        },
        {
          "id": 2,
          "users": []
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all users which belongs to the team.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/users

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Get a team

    Response 200 OK

    {
      "_results": {
        "id": 4,
        "name": "Team #2",
        "created_at": "2017-09-28T13:11:16+02:00",
        "_links": {
          "self": "/v1/teams/4"
        }
      }
    }
    

    This endpoint retrieves a specific team.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Get a team ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "updated_at": "2017-10-24T13:37:01+02:00",
          "ticket": null,
          "survey": {
            "id": 1,
            "type": "CSAT"
          },
    
          ...
        },
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to the team.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/<ID>/ratings

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a team stats

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "average": 0,
          "count": 0
        },
        "CES": {
          "average": 0,
          "count": 0
        },
        "NPS": {
          "nps_score": 0,
          "count": 0,
          "groups": {
            "promoters": 0,
            "passives": 0,
            "detractors": 0
          }
        }
      }
    }
    

    This endpoint retrieves team stats for all metric types.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/<ID>/stats

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a team histogram

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "histogram": {
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0,
            "8": 0,
            "9": 0,
            "10": 0
          }
        },
        "CES": {
          "histogram": {
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0
          }
        },
        "NPS": {
          "histogram": {
            "0": 0,
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0,
            "8": 0,
            "9": 0,
            "10": 0
          }
        }
      }
    }
    

    This endpoint retrieves team histogram for all metric types.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/<ID>/histogram

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a team users

    Response 200 OK

    {
      "_results": [
        {
          "id": 98,
          "username": "agentBob",
          "integration_usernames": [],
          "fullname": "Uncle Bob",
          "email": "unclebob@example.com",
          "role": "admin",
          "created_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/users/98"
          }
        }
      ],
      "_pagination": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all users which belongs to the team.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/teams/<ID>/users

    URL Parameters

    Parameter Type Description
    ID integer The ID of the team to retrieve

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Users

    User model fields

    Field Type Description
    id integer
    username string
    integration_usernames array Array of integration_usernames objects
    fullname string
    email string
    role string(enum) Valid values: admin, employee or restricted
    created_at string ISO8601 date

    integration_usernames object fields

    Field Type Nullable Description
    id integer No
    username string No
    type string(enum) No Valid values: zendesk, desk, desk-oauth, helpscout, salesforce, front, front-v2, freshdesk, liveagent, liveagent-v2, kayako, kayako-v2, teamsupport, deskpro, kustomer, groove, shopify, intercom

    Get all users

    Response 200 OK

    {
      "_results": [
        {
          "id": 98,
          "username": "agentBob",
          "integration_usernames": [
            {
              "id": 123,
              "username": "98463782636",
              "type": "zendesk"
            }
          ],
          "fullname": "Uncle Bob",
          "email": "unclebob@example.com",
          "role": "admin",
          "created_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/users/98"
          }
        },
        {
          "id": 25,
          "username": "aaronwalker",
          "integration_usernames": [],
          "fullname": "Aaron Walker",
          "email": "aaronwalker@example.com",
          "role": "employee",
          "created_at": "2017-10-24T13:37:01+02:00",
          "_links": {
            "self": "/v1/users/25"
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your users.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/users

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.

    Get stats for all users

    Response 200 OK

    {
      "_results": [
        {
          "id": 98,
          "stats": {
            "CSAT": {
              "average": 0,
              "count": 0
            },
            "CES": {
              "average": 0,
              "count": 0
            },
            "NPS": {
              "average": 0,
              "count": 0,
              "groups": {
                "promoters": 0,
                "passives": 0,
                "detractors": 0
              }
            }
          }
        },
        {
          "id": 25,
          "stats": {
            "CSAT": {
              "average": 0,
              "count": 0
            },
            "CES": {
              "average": 0,
              "count": 0
            },
            "NPS": {
              "nps_score": 0,
              "count": 0,
              "groups": {
                "promoters": 0,
                "passives": 0,
                "detractors": 0
              }
            }
          }
        }
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all your users with stats.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/users/stats

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a user

    Response 200 OK

    {
      "_results": {
        "id": 98,
        "username": "agentBob",
        "integration_usernames": [
          {
            "id": 123,
            "username": "98463782636",
            "type": "zendesk"
          }
        ],
        "fullname": "Uncle Bob",
        "email": "unclebob@example.com",
        "role": "admin",
        "created_at": "2017-10-24T13:37:01+02:00",
        "_links": {
          "self": "/v1/users/98"
        }
      }
    }
    

    This endpoint retrieves a specific user.

    HTTP Request

    GET https://api.nicereply.com/v1/users/<ID>

    URL Parameters

    Parameter Type Description
    ID integer The ID of the user to retrieve

    Get a user ratings

    Response 200 OK

    {
      "_results": [
        {
          "id": 1,
          "score": 5,
          "from": "Viktor Magic",
          "ip_address": "8.8.8.8",
          "comment": "Nice reply! :)",
          "created_at": "2017-10-24T13:37:01+02:00",
          "ticket": null,
          "survey": {
            "id": 1,
            "type": "CSAT"
          },
    
          ...
        },
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all ratings which belongs to the user.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/users/<ID>/ratings

    URL Parameters

    Parameter Type Description
    ID integer The ID of the user to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).
    sort_order No desc Valid values is: asc or desc.

    Get a user stats

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "average": 0,
          "count": 0
        },
        "CES": {
          "average": 0,
          "count": 0
        },
        "NPS": {
          "nps_score": 0,
          "count": 0,
          "groups": {
            "promoters": 0,
            "passives": 0,
            "detractors": 0
          }
        }
      }
    }
    

    This endpoint retrieves user stats for all metric types.

    HTTP Request

    GET https://api.nicereply.com/v1/users/<ID>/stats

    URL Parameters

    Parameter Type Description
    ID integer The ID of the user to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a user histogram

    Response 200 OK

    {
      "_results": {
        "CSAT": {
          "histogram": {
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0,
            "8": 0,
            "9": 0,
            "10": 0
          }
        },
        "CES": {
          "histogram": {
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0
          }
        },
        "NPS": {
          "histogram": {
            "0": 0,
            "1": 0,
            "2": 0,
            "3": 0,
            "4": 0,
            "5": 0,
            "6": 0,
            "7": 0,
            "8": 0,
            "9": 0,
            "10": 0
          }
        }
      }
    }
    

    This endpoint retrieves user histogram for all metric types.

    HTTP Request

    GET https://api.nicereply.com/v1/users/<ID>/histogram

    URL Parameters

    Parameter Type Description
    ID integer The ID of the user to retrieve

    Query Parameters

    Parameter Required Default Description
    period_start No none Period start (ISO8601 date).
    period_end No none Period end (ISO8601 date).

    Get a user teams

    Response 200 OK

    {
      "_results": [
        {
          "id": 4,
          "name": "Team #2",
          "created_at": "2017-09-28T13:11:16+02:00",
          "_links": {
            "self": "/v1/teams/4"
          }
        },
    
        ...
      ],
      "_pagination": {
        "total": 2,
        "count": 2,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1,
        "links": { }
      }
    }
    

    This endpoint retrieves all teams which belongs to the user.
    Sorting is performed by id field.

    HTTP Request

    GET https://api.nicereply.com/v1/users/<ID>/teams

    URL Parameters

    Parameter Type Description
    ID integer The ID of the user to retrieve

    Query Parameters

    Parameter Required Default Description
    sort_order No desc Valid values is: asc or desc.