GET /(/:locale)/api_integration/contracts
List contracts

Returns a paginated list of all contracts of your company. Each contract has its user. Within the headers you may find the Total number of contracts (Total). To access the profile picture, use the contract.user.profile_picture_cloudinary_id as follows:

"https://res.cloudinary.com/qulture/image/upload/{{contract.user.profile_picture_cloudinary_id}}.png"

Which should result in:

"https://res.cloudinary.com/qulture/image/upload/eyrkci3nmanvh7oubebq.png"

Headers¶ ↑

Total: The total amount of contracts

Examples

{
  contracts: [
    {
        active: true,
        admission_date: '2015-11-01',
        area: 'North',
        birth_date: '1990-01-30',
        company_id: 72,
        country: 'Westeros',
        cpf: '30312345689',
        created_at: '2016-10-03T20:14:43.678-03:00',
        department: 'Ice',
        education: 'N/A',
        email: 'john@snow.got',
        id: 5828,
        job_title: 'King in the North',
        last_career_move_date: '2016-01-30',
        last_invitation_sent_at: '2016-10-06T11:12:33.417-03:00',
        level: 'Reborn',
        location: 'Westeros',
        name: 'John Snow',
        nickname: 'Knows nothing',
        objectives_average_by_cycle: {12: 88},
        rg: '123456789',
        role: 'member',
        salary_rage: 'R$1000 a R$2000',
        sex: 'male',
        supervisor_id: 5822,
        termination_date: null,
        termination_reason: null,
        user: {
            id: 5465,
            name: 'John Snow',
            email: 'john@snow.got',
            profile_picture_cloudinary_id: 'eyrkci3nmanvh7oubebq',
            preferred_language: 'pt',
            created_at: '2016-10-03T20:14:43.676-03:00',
            sign_in_count: 1
        }
    }
  ]
}

Params

Param name	Description
per_page optional	How many items per page. Default: 10. Max: 50. Validations: Must be a number.
page optional	Page number. Default: 1 Validations: Must be a number.
search optional	Search by name or nickname Validations: Must be a String
active optional	Active contracts. Default: true Validations: Must be one of: true, false, 1, 0.
inactive optional	Inactive contracts. Default: false. If you want to fetch inactive contracts only, set active to false as well. Validations: Must be one of: true, false, 1, 0.
with_email optional	Search by email Validations: Must be a String
with_email_or_cpf optional	Search by email or CPF Validations: Must be a String
with_username optional	Search by username Validations: Must be a String
order_by_nickname_or_name optional	Order name or nickname. Default: true Validations: Must be one of: true, false, 1, 0.