Pickup Number Agent Search
<h2>Overview</h2>
<p>The API endpoint is used to fetch pickup number agents by their names. The name parameter allows filtering by the name of the pickup number agent. Replace xx with the actual name you want to search for.</p>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/pickupNumberAgents?name=xx</code></li>
</ul>
<h2>Code Example</h2>
<pre><code>Request:
curl --location 'https://api.drayeasy.com/api/v2/pickupNumberAgents?name=test' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
Response:
HTTP/1.1 201 OK
Content-Type: application/json; charset=utf-8
{
&quot;data&quot;: [
{
&quot;id&quot;: 1,
&quot;name&quot;: &quot;test create pu&quot;,
&quot;emails&quot;: [
&quot;email1@agent.com&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
},
{
&quot;id&quot;: 4,
&quot;name&quot;: &quot;test3&quot;,
&quot;emails&quot;: [
&quot;33@q.c&quot;,
&quot;44@q.c&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
},
{
&quot;id&quot;: 8,
&quot;name&quot;: &quot;test Name4&quot;,
&quot;emails&quot;: [
&quot;name4@gent.com&quot;,
&quot;name4test@gent.com&quot;
],
&quot;user_id&quot;: 4,
&quot;user&quot;: {
&quot;id&quot;: 4,
&quot;name&quot;: &quot;Name4&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
},
{
&quot;id&quot;: 9,
&quot;name&quot;: &quot;testAPIV2&quot;,
&quot;emails&quot;: [
&quot;33@q.c&quot;,
&quot;44@q.c&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
},
{
&quot;id&quot;: 10,
&quot;name&quot;: &quot;test update pu agent&quot;,
&quot;emails&quot;: [
&quot;pu1@agent.com&quot;,
&quot;pu2@agent.com&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
}
],
&quot;links&quot;: {
&quot;first&quot;: &quot;https://api.drayeasy.com/api/v2/pickupNumberAgents?page=1&quot;,
&quot;last&quot;: &quot;https://api.drayeasy.com/api/v2/pickupNumberAgents?page=1&quot;,
&quot;prev&quot;: null,
&quot;next&quot;: null
},
&quot;meta&quot;: {
&quot;current_page&quot;: 1,
&quot;from&quot;: 1,
&quot;last_page&quot;: 1,
&quot;path&quot;: &quot;https://api.drayeasy.com/api/v2/pickupNumberAgents&quot;,
&quot;per_page&quot;: 1000,
&quot;to&quot;: 5,
&quot;total&quot;: 5
}
}</code></pre>
<h2>Response Fields Description</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>The unique identifier for the pickup agent.</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the pickup number agent.</td>
</tr>
<tr>
<td>emails</td>
<td>Array</td>
<td>An array of email addresses associated with the pickup agent.</td>
</tr>
<tr>
<td>user_id</td>
<td>Integer</td>
<td>The user ID associated with the pickup agent.</td>
</tr>
<tr>
<td>user</td>
<td>Object</td>
<td>Information about the user associated with the pickup agent, including their ID, name, and company details.</td>
</tr>
<tr>
<td>user.id</td>
<td>Integer</td>
<td>The user's unique identifier.</td>
</tr>
<tr>
<td>user.name</td>
<td>String</td>
<td>The user's name.</td>
</tr>
<tr>
<td>user.company</td>
<td>Object</td>
<td>Information about the company associated with the user, including its ID and name.</td>
</tr>
<tr>
<td>user.company.id</td>
<td>Integer</td>
<td>The company's unique identifier.</td>
</tr>
<tr>
<td>user.company.name</td>
<td>String</td>
<td>The name of the company.</td>
</tr>
</tbody>
</table>
<h2>User Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>The name of the user.</td>
</tr>
<tr>
<td>email</td>
<td>The email address of the user.</td>
</tr>
<tr>
<td>company</td>
<td>The company associated with the user.</td>
</tr>
</tbody>
</table>