List an employee's milestones

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/milestones/employee/EMP-00007?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.milestones.milestones_dto.MilestonesDto;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<MilestonesDto.Milestones> response = client.milestones().getMilestonesEmployeeByCode(
        "EMP-00007",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Milestones.GetMilestonesEmployeeByCodeAsync(
    "EMP-00007",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.milestones.getMilestonesEmployeeByCode(
  'EMP-00007',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Milestones().GetMilestonesEmployeeByCode(context.Background(), "EMP-00007", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": "<array>",
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

milestones

employee

{employee_code}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/milestones/employee/EMP-00007?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.milestones.milestones_dto.MilestonesDto;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<MilestonesDto.Milestones> response = client.milestones().getMilestonesEmployeeByCode(
        "EMP-00007",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Milestones.GetMilestonesEmployeeByCodeAsync(
    "EMP-00007",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.milestones.getMilestonesEmployeeByCode(
  'EMP-00007',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Milestones().GetMilestonesEmployeeByCode(context.Background(), "EMP-00007", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": "<array>",
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the employee’s milestones under data, with pagination. The path takes the employee’s code; an emp_ id returns 404. Any other field of the record filters the listing as filter_<field> or filter_<field>_<operator>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

employee_code

string

required

The employee's code, not its emp_ id.

Query Parameters

limit

integer

How many records to return on one page.

Example:

20

cursor

string

The next_cursor of the previous page, to fetch the page after it.

sort

string

The field to sort by; prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

The employee's milestones.

data

array

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

Authorizations

Path Parameters

Query Parameters

Response